Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2016 M1602 Make image loads conform with the spec

2016-04-15T20:50:59Z

Agupta27: /* Conclusion */

Making image load conform with the spec 
[https://en.wikipedia.org/wiki/HTML5 HTML 5] specifies a complex model for image loading on a web browser. It has specifications<ref>https://html.spec.whatwg.org/multipage/#the-picture-element</ref> for [https://html.spec.whatwg.org/multipage/#the-picture-element picture element] as well as img element, and browsers need to follow these HTML 5 specifications to conform to the standard. Servo's current implementation of image loading is [http://mxr.mozilla.org/servo/source/components/script/dom/htmlimageelement.rs#107 straightforward, but non-compliant] with HTML 5 standards<ref>https://html.spec.whatwg.org/multipage/</ref> in a number of important ways. The goal of this project is to implement image loading behavior on Servo browser that is more compliant with HTML 5 so its easy to both implement and verify against the text of the specification.

[https://github.com/servo/servo Servo] is a [https://en.wikipedia.org/wiki/Web_browser web browser] layout engine written in [https://www.mozilla.org/en-US/?v=b Mozilla]'s new [https://en.wikipedia.org/wiki/System_programming_language systems language] [https://en.wikipedia.org/wiki/Rust_(programming_language) Rust]<ref>https://servo.org/</ref>. It is currently being developed by Mozilla Research. The aim of the project is not to create a full browser but rather to create better parallelism<ref>https://www.usenix.org/legacy/event/hotpar09/tech/full_papers/jones/jones.pdf</ref>, security<ref>https://en.wikipedia.org/wiki/Browser_security</ref>, modularity<ref>https://msdn.microsoft.com/en-us/library/ff709921.aspx</ref> and performance. The Servo project is [https://en.wikipedia.org/wiki/Open-source_software open sourced] and receives contributions from individual contributors from around the globe. It currently supports [https://www.linux.com/ Linux], [http://www.apple.com/osx/ OS X], [https://www.microsoft.com/en-us/windows Windows], [https://www.android.com/ Android], and [https://en.wikipedia.org/wiki/Gonk Gonk] (Firefox OS).

Hatched by Mozilla employee Graydon Hoare back in 2009, Rust was built from the ground up using elements from modern programming language design<ref>http://readwrite.com/2015/07/02/mozilla-rust-programming-language-potential/</ref>. Rust is a [https://en.wikipedia.org/wiki/General-purpose_programming_language general-purpose], [https://developer.mozilla.org/ar/docs/multiparadigmlanguage.html multi-paradigm], [https://en.wikipedia.org/wiki/Compiled_language compiled programming] language, supporting pure-functional, imperative-procedural, and object-oriented styles<ref>https://en.wikipedia.org/wiki/Rust_(programming_language)</ref>. It focuses on performance, parallelization, and memory safety and does so because unlike other programming languages it doesn't suffer from "backward-compatibility requirements"<ref>http://readwrite.com/2015/07/02/mozilla-rust-programming-language-potential/</ref>.

==Project Description==
The detailed description of the project can be found [https://github.com/servo/servo/wiki/Image-load-conformance-student-project here].

The steps are as follows:

===Compilation and Build===
* The first step is to compile Servo browser and build it on a local machine. The steps for compiling and building Servo are:
Servo is built with [https://mail.mozilla.org/pipermail/rust-dev/2014-March/009090.html Cargo], the Rust package manager. Mozilla's Mach tools are used to orchestrate the build and other tasks.

git clone https://github.com/servo/servo
cd servo
./mach build --dev
./mach run tests/html/about-mozilla.html

compile Servo and ensure that it runs tests/html/about-mozilla.html

===Initial Steps===
The initial steps for the project were completed as a part of OSS project 2. The functionalities implemented were:
* Additional data types were defined in the HTML Image Element to add pending requests as well as current requests. The existing data types were modified so current request was used to store the image properties.
* A new attribute called Cross Origin was uncommented from existing Servo code and the make_enumerated_getter and setter macros were added to the code to implement Cross Origin.
* Current Src attribute was added to HTMLImageElement.webidl and appropriate attributes were added for its functionality.
* Image caching task was implemented, which accepted a URL and a vector of bytes. The cache was used to store the data collected as a newly-complete network request and continue decoding the result into pixel data.

==Design Principles==

These principles, when combined together, make it easy for a programmer to develop software that are easy to maintain and extend. They also make it easy for developers to avoid code smells, easily refactor code, and are also a part of the agile or adaptive software development.

===DRY Principle===

The very first design principle used was the DRY (don't repeat yourself) principle. The essence of this principle is to reduce repetition of information of all kinds. With the use of DRY principle, a modification of any single element of a system does not require a change in other logically unrelated elements. Additionally, elements that are logically related all change predictably and uniformly, and are thus kept in sync<ref>https://en.wikipedia.org/wiki/Don%27t_repeat_yourself</ref>.

===Observer Pattern===

The Servo project follows an Event-driven architecture (EDA), also known as Message-driven architecture, which is any software architecture pattern promoting the production, detection, consumption of, and reaction to [https://en.wikipedia.org/wiki/Event_(computing) events]. An event can be defined as "a significant change in state".<ref>https://en.wikipedia.org/wiki/Event-driven_architecture</ref> The biggest example of event-driven architecture is the Observer Pattern, which is a software design pattern in which an object, called the subject, maintains a list of its dependents, called observers, and notifies them automatically of any state changes, usually by calling one of their methods.<ref>https://en.wikipedia.org/wiki/Observer_pattern</ref> We are following the Observer Pattern by defining subjects having some observer dependencies, which are notified about state changes through the calling of one of our methods.

===UML Class Diagram===

The following is a class diagram depicting the steps involved in the project. For readability purposes, only the classes relevant to the project have been depicted.

[[File:class_diagram_M1602.png]]

===Flowcharts===

This project involves implementing several algorithms while making changes in the HTML image element. The flowcharts of the algorithms have been depicted below.

====Algorithm 1====

[[File:updatesrc_2.png]]

====Algorithm 2====

[[File:parsasize.png]]

====Algorithm 3====

[[File:updatesrc.png]]

==Implementation==
===Initial Steps===
The following steps were followed to meet the project requirements as per this [https://github.com/servo/servo/wiki/Image-load-conformance-student-project github page].

====Step 1====

Defined data types to represent the image request concept, and add pending and current requests to the HTML image element. These had to subsume the existing fields in HTMLImageElement that are used for storing the image's properties, and the fields of the current request had to be used instead.

====Step 2====

Implemented the cross origin attribute , for which we uncommented it in the HTMLImageElement.webidl file and then we created a getter and setter method for it in the HTMLImageElement.rd file using the make_enumerated_getter / make_setter macros .

====Step 3====

Implemented the current SRC attribute by adding the appropriate attribute to HTMLImageElement.webidl.

===Subsequent Steps===

These steps have to be implemented as a part of the final OSS project. The class diagram for this project is given [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_M1602_Make_image_loads_conform_with_the_spec#UML_Class_Diagram here]. The following are the steps required to complete the final project.

====Step 1====

Adding a functionality html image element to replace existing image cache functionality and instruct it to fetch a URL directly from a network request. The code should enable the result to be sent directly to the image cache.

====Step 2====

Implementing the parse a srcset attribute algorithm by defining a method to parse a scrset based on HTML 5 standards. To demonstrate the correctness of the algorithm, write unit tests in tests/unit/script/htmlimageelement.rs. The flowchart for the algorithm is given [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_M1602_Make_image_loads_conform_with_the_spec#Algorithm_1 here]

====Step 3====

Implementing the parse a sizes attribute algorithm by defining a method to parse an image size based on HTML 5 standards. To demonstrate the correctness of the algorthim, write unit tests in tests/unit/script/htmlimageelement.rs . The flowchart for the algorithm can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_M1602_Make_image_loads_conform_with_the_spec#Algorithm_2 here]

====Step 4====

Implementing the normalize the source densities algorithm by creating data types for the source set and image source.

====Step 5====

Implementing the update the source set algorithm by defining a method to update the source based on HTML 5 standards in htmlimageelement.rs. The flowchart for this algorithm can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_M1602_Make_image_loads_conform_with_the_spec#Algorithm_3 here]

====Step 6====

Implementing the select an image source algorithm by defining a method to select an image source based on HTML 5 standards in htmlimageelement.rs

== Testing ==

Following are the steps to run all the tests for HTMLImageElement:

# Install the pre-requisites required for servo as mentioned [https://github.com/servo/servo/blob/master/README.md here]
# Run the following command on your terminal

<code>
./mach run tests/html/about-mozilla.html
</code>

The Servo browser should open and load the about-Mozilla web page.
Now run the following command:

<code>
./mach test-wpt tests/wpt/web-platform-tests/html/dom/interfaces.html
</code>

You will see that all tests pass as expected.

'''Note:''' We have not added any new tests to the test suite as servo follows TDD and tests were previously written for HTML image element. We have just adjusted some of the test expectations for the tests which now pass due to our implementation.

===Test Tidy===

The Mozilla development team has a strict coding standard that all projects have to adhere to. To ensure that the project code conforms with the Mozilla coding standard, they have a code given below:

<code>
./mach test-tidy
</code>

Issues reported by test are to be fixed before pull request can be generated. Once the test passes, it means that our code is following the standards of Mozilla. Running the above code, you can see that it passes and our code conforms to the Mozilla coding standards.

=== Testing From UI ===

Our project cannot be tested from UI since the project aims to make image loading on Servo browser more conformant to HTML5 standards. However you can check that it doesn't break the existing code and the browser runs correctly by running a test page on servo after performing the build as mentioned above.

Run the following command after the project is build:

<code>
./mach run tests/html/about-mozilla.html
</code>

If the browser is opened without any error messages, it means Servo is working as expected and our code modifications have not caused existing code to break.

==Conclusion==

As a result of our changes in the initial and subsequent parts of the project, servo's image loading algorithms and behavior will be conformable to HTML5 specification and it would be possible to verify the behavior against the specification.

==References==
<references/>

CSC/ECE 517 Spring 2016 M1602 Make image loads conform with the spec

2016-04-15T20:50:43Z

Agupta27: /* Conclusion */

Making image load conform with the spec 
[https://en.wikipedia.org/wiki/HTML5 HTML 5] specifies a complex model for image loading on a web browser. It has specifications<ref>https://html.spec.whatwg.org/multipage/#the-picture-element</ref> for [https://html.spec.whatwg.org/multipage/#the-picture-element picture element] as well as img element, and browsers need to follow these HTML 5 specifications to conform to the standard. Servo's current implementation of image loading is [http://mxr.mozilla.org/servo/source/components/script/dom/htmlimageelement.rs#107 straightforward, but non-compliant] with HTML 5 standards<ref>https://html.spec.whatwg.org/multipage/</ref> in a number of important ways. The goal of this project is to implement image loading behavior on Servo browser that is more compliant with HTML 5 so its easy to both implement and verify against the text of the specification.

[https://github.com/servo/servo Servo] is a [https://en.wikipedia.org/wiki/Web_browser web browser] layout engine written in [https://www.mozilla.org/en-US/?v=b Mozilla]'s new [https://en.wikipedia.org/wiki/System_programming_language systems language] [https://en.wikipedia.org/wiki/Rust_(programming_language) Rust]<ref>https://servo.org/</ref>. It is currently being developed by Mozilla Research. The aim of the project is not to create a full browser but rather to create better parallelism<ref>https://www.usenix.org/legacy/event/hotpar09/tech/full_papers/jones/jones.pdf</ref>, security<ref>https://en.wikipedia.org/wiki/Browser_security</ref>, modularity<ref>https://msdn.microsoft.com/en-us/library/ff709921.aspx</ref> and performance. The Servo project is [https://en.wikipedia.org/wiki/Open-source_software open sourced] and receives contributions from individual contributors from around the globe. It currently supports [https://www.linux.com/ Linux], [http://www.apple.com/osx/ OS X], [https://www.microsoft.com/en-us/windows Windows], [https://www.android.com/ Android], and [https://en.wikipedia.org/wiki/Gonk Gonk] (Firefox OS).

Hatched by Mozilla employee Graydon Hoare back in 2009, Rust was built from the ground up using elements from modern programming language design<ref>http://readwrite.com/2015/07/02/mozilla-rust-programming-language-potential/</ref>. Rust is a [https://en.wikipedia.org/wiki/General-purpose_programming_language general-purpose], [https://developer.mozilla.org/ar/docs/multiparadigmlanguage.html multi-paradigm], [https://en.wikipedia.org/wiki/Compiled_language compiled programming] language, supporting pure-functional, imperative-procedural, and object-oriented styles<ref>https://en.wikipedia.org/wiki/Rust_(programming_language)</ref>. It focuses on performance, parallelization, and memory safety and does so because unlike other programming languages it doesn't suffer from "backward-compatibility requirements"<ref>http://readwrite.com/2015/07/02/mozilla-rust-programming-language-potential/</ref>.

==Project Description==
The detailed description of the project can be found [https://github.com/servo/servo/wiki/Image-load-conformance-student-project here].

The steps are as follows:

===Compilation and Build===
* The first step is to compile Servo browser and build it on a local machine. The steps for compiling and building Servo are:
Servo is built with [https://mail.mozilla.org/pipermail/rust-dev/2014-March/009090.html Cargo], the Rust package manager. Mozilla's Mach tools are used to orchestrate the build and other tasks.

git clone https://github.com/servo/servo
cd servo
./mach build --dev
./mach run tests/html/about-mozilla.html

compile Servo and ensure that it runs tests/html/about-mozilla.html

===Initial Steps===
The initial steps for the project were completed as a part of OSS project 2. The functionalities implemented were:
* Additional data types were defined in the HTML Image Element to add pending requests as well as current requests. The existing data types were modified so current request was used to store the image properties.
* A new attribute called Cross Origin was uncommented from existing Servo code and the make_enumerated_getter and setter macros were added to the code to implement Cross Origin.
* Current Src attribute was added to HTMLImageElement.webidl and appropriate attributes were added for its functionality.
* Image caching task was implemented, which accepted a URL and a vector of bytes. The cache was used to store the data collected as a newly-complete network request and continue decoding the result into pixel data.

==Design Principles==

These principles, when combined together, make it easy for a programmer to develop software that are easy to maintain and extend. They also make it easy for developers to avoid code smells, easily refactor code, and are also a part of the agile or adaptive software development.

===DRY Principle===

The very first design principle used was the DRY (don't repeat yourself) principle. The essence of this principle is to reduce repetition of information of all kinds. With the use of DRY principle, a modification of any single element of a system does not require a change in other logically unrelated elements. Additionally, elements that are logically related all change predictably and uniformly, and are thus kept in sync<ref>https://en.wikipedia.org/wiki/Don%27t_repeat_yourself</ref>.

===Observer Pattern===

The Servo project follows an Event-driven architecture (EDA), also known as Message-driven architecture, which is any software architecture pattern promoting the production, detection, consumption of, and reaction to [https://en.wikipedia.org/wiki/Event_(computing) events]. An event can be defined as "a significant change in state".<ref>https://en.wikipedia.org/wiki/Event-driven_architecture</ref> The biggest example of event-driven architecture is the Observer Pattern, which is a software design pattern in which an object, called the subject, maintains a list of its dependents, called observers, and notifies them automatically of any state changes, usually by calling one of their methods.<ref>https://en.wikipedia.org/wiki/Observer_pattern</ref> We are following the Observer Pattern by defining subjects having some observer dependencies, which are notified about state changes through the calling of one of our methods.

===UML Class Diagram===

The following is a class diagram depicting the steps involved in the project. For readability purposes, only the classes relevant to the project have been depicted.

[[File:class_diagram_M1602.png]]

===Flowcharts===

This project involves implementing several algorithms while making changes in the HTML image element. The flowcharts of the algorithms have been depicted below.

====Algorithm 1====

[[File:updatesrc_2.png]]

====Algorithm 2====

[[File:parsasize.png]]

====Algorithm 3====

[[File:updatesrc.png]]

==Implementation==
===Initial Steps===
The following steps were followed to meet the project requirements as per this [https://github.com/servo/servo/wiki/Image-load-conformance-student-project github page].

====Step 1====

Defined data types to represent the image request concept, and add pending and current requests to the HTML image element. These had to subsume the existing fields in HTMLImageElement that are used for storing the image's properties, and the fields of the current request had to be used instead.

====Step 2====

Implemented the cross origin attribute , for which we uncommented it in the HTMLImageElement.webidl file and then we created a getter and setter method for it in the HTMLImageElement.rd file using the make_enumerated_getter / make_setter macros .

====Step 3====

Implemented the current SRC attribute by adding the appropriate attribute to HTMLImageElement.webidl.

===Subsequent Steps===

These steps have to be implemented as a part of the final OSS project. The class diagram for this project is given [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_M1602_Make_image_loads_conform_with_the_spec#UML_Class_Diagram here]. The following are the steps required to complete the final project.

====Step 1====

Adding a functionality html image element to replace existing image cache functionality and instruct it to fetch a URL directly from a network request. The code should enable the result to be sent directly to the image cache.

====Step 2====

Implementing the parse a srcset attribute algorithm by defining a method to parse a scrset based on HTML 5 standards. To demonstrate the correctness of the algorithm, write unit tests in tests/unit/script/htmlimageelement.rs. The flowchart for the algorithm is given [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_M1602_Make_image_loads_conform_with_the_spec#Algorithm_1 here]

====Step 3====

Implementing the parse a sizes attribute algorithm by defining a method to parse an image size based on HTML 5 standards. To demonstrate the correctness of the algorthim, write unit tests in tests/unit/script/htmlimageelement.rs . The flowchart for the algorithm can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_M1602_Make_image_loads_conform_with_the_spec#Algorithm_2 here]

====Step 4====

Implementing the normalize the source densities algorithm by creating data types for the source set and image source.

====Step 5====

Implementing the update the source set algorithm by defining a method to update the source based on HTML 5 standards in htmlimageelement.rs. The flowchart for this algorithm can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_M1602_Make_image_loads_conform_with_the_spec#Algorithm_3 here]

====Step 6====

Implementing the select an image source algorithm by defining a method to select an image source based on HTML 5 standards in htmlimageelement.rs

== Testing ==

Following are the steps to run all the tests for HTMLImageElement:

# Install the pre-requisites required for servo as mentioned [https://github.com/servo/servo/blob/master/README.md here]
# Run the following command on your terminal

<code>
./mach run tests/html/about-mozilla.html
</code>

The Servo browser should open and load the about-Mozilla web page.
Now run the following command:

<code>
./mach test-wpt tests/wpt/web-platform-tests/html/dom/interfaces.html
</code>

You will see that all tests pass as expected.

'''Note:''' We have not added any new tests to the test suite as servo follows TDD and tests were previously written for HTML image element. We have just adjusted some of the test expectations for the tests which now pass due to our implementation.

===Test Tidy===

The Mozilla development team has a strict coding standard that all projects have to adhere to. To ensure that the project code conforms with the Mozilla coding standard, they have a code given below:

<code>
./mach test-tidy
</code>

Issues reported by test are to be fixed before pull request can be generated. Once the test passes, it means that our code is following the standards of Mozilla. Running the above code, you can see that it passes and our code conforms to the Mozilla coding standards.

=== Testing From UI ===

Our project cannot be tested from UI since the project aims to make image loading on Servo browser more conformant to HTML5 standards. However you can check that it doesn't break the existing code and the browser runs correctly by running a test page on servo after performing the build as mentioned above.

Run the following command after the project is build:

<code>
./mach run tests/html/about-mozilla.html
</code>

If the browser is opened without any error messages, it means Servo is working as expected and our code modifications have not caused existing code to break.

==Conclusion==

As a result of our changes in the initial and subsequent parts of the project, servo's image loading algorithms and behaviour will be comformable to HTML5 specification and it would be possible to verify the behavior against the specification.

==References==
<references/>

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T03:36:33Z

Agupta27: /* 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===
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>

===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:17:18Z

Agupta27: /* Factory Girl */

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T03:11:32Z

Agupta27: /* 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.

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

<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</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.

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

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T03:11:11Z

Agupta27: /* Building Factories */

=== 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>

===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-03-30T19:37:37Z

Agupta27: Redirected page to CSC/ECE 517 Spring 2016/OSS E1601

#REDIRECT [[CSC/ECE 517 Spring 2016/OSS E1601]]

CSC/ECE 517 Spring 2016 OSS E1601

2016-03-30T19:37:09Z

Agupta27:

{{delete| not required }}
#REDIRECT [[CSC/ECE 517 Spring 2016/OSS E1601]]

CSC/ECE 517 Spring 2016

2016-03-30T19:32:04Z

Agupta27: /* Writing Assignment 2 */

==Writing Assignment 1==
*[[CSC/ECE 517 Spring 2016/Active Job]]

==Calibration Assignment Submissions==
*[[Calibration Assignment Submission (OmniAuth)]]
*[[Calibration Assignment Submission (Patch_verb)]]

==Writing Assignment 2==
*[[CSC/ECE 517 Spring 2016/Mozilla Implement HTML5 form validation]]

*[[CSC/ECE 517 Spring 2016/Functional Tests for Questionnaire Controller]]

*[[CSC/ECE 517 Spring 2016 / Expertiza Self-Review Feature]]

*[[CSC/ECE 517 Spring 2016/Refactor different question types from quiz feature]]

*[[CSC/ECE 517 Spring 2016/Implement private browsing]]

*[[CSC/ECE 517 Spring 2016/Write automated tests for WebDriver]]

*[[CSC/ECE 517 Spring 2016/Refactor sign_up_sheet_controller.rb and sign_up_topic.rb]]

*[[CSC/ECE 517 Spring 2016/Implement Common Parts of the CSSOM API]]

*[[CSC/ECE 517 Spring 2016/Functional tests for assignment creation function]]

*[[CSC/ECE 517 Spring 2016/E1604. Functional tests for Calibration function]]

*[[CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb]]

*[[CSC/ECE 517 Spring 2016/Refactor response controller]]

*[[CSC/ECE_517_Spring_2016_OSS_M1606]]

*[[CSC/ECE_517_Spring_2016/OSS_E1601]]

CSC/ECE 517 Spring 2016

2016-03-30T19:31:25Z

Agupta27: /* Writing Assignment 2 */

CSC/ECE 517 Spring 2016

2016-03-30T19:30:44Z

Agupta27: /* Writing Assignment 2 */

CSC/ECE 517 Spring 2016 OSS E1601

2016-03-30T19:18:54Z

Agupta27: moved CSC/ECE 517 Spring 2016 OSS E1601 to CSC/ECE 517 Spring 2016/OSS E1601

#REDIRECT [[CSC/ECE 517 Spring 2016/OSS E1601]]

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:18:54Z

Agupta27: moved CSC/ECE 517 Spring 2016 OSS E1601 to CSC/ECE 517 Spring 2016/OSS E1601

=== 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:15:48Z

Agupta27: /* Problem statement */

=== 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:14:48Z

Agupta27: /* Problem statement */

=== 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::'' Refactoring the 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:14:18Z

Agupta27: /* Problem statement */

=== 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::'' Refactoring controller methods to reflect the refactoring.

''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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:13:53Z

Agupta27: /* Problem statement */

=== 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::'' Refactoring controller methods to reflect the changes.

''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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:12:02Z

Agupta27: /* Key changes */

=== 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::'' 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:11:26Z

Agupta27: /* Key changes */

=== 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::'' 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:10:16Z

Agupta27: /* Key changes */

=== 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::'' 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:08:26Z

Agupta27: /* Key changes */

=== 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::'' 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:07:07Z

Agupta27: /* Problem statement */

=== 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::'' 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:06:40Z

Agupta27: /* Key changes */

=== 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 ::'' 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:05:30Z

Agupta27: /* Problem statement */

=== 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 ::'' 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:05:00Z

Agupta27: /* Problem statement */

=== 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'' 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T19:04:40Z

Agupta27: /* Problem statement */

=== 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'' 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:56:54Z

Agupta27: /* Expertiza Introduction */

=== 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''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:53:04Z

Agupta27: /* Problem statement */

=== 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 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''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:52:37Z

Agupta27: /* Problem statement */

=== 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 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 efficiency of code.

'''What refactoring we have done to improve the code''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:51:46Z

Agupta27: /* Problem statement */

=== 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 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. They are to be moved to assignment_teams.rb for improving the clarity and efficiency of code.

'''What refactoring we have done to improve the code''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:51:25Z

Agupta27: /* Problem statement */

=== 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 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, 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. They are to be moved to assignment_teams.rb for improving the clarity and efficiency of code.

'''What refactoring we have done to improve the code''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:51:07Z

Agupta27: /* Problem statement */

=== 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 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 there is only one person in the team, 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. They are to be moved to assignment_teams.rb for improving the clarity and efficiency of code.

'''What refactoring we have done to improve the code''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:36:12Z

Agupta27: /* Peer Review Information */

=== 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 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve the code''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:31:46Z

Agupta27: /* Problem statement */

=== 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve the code''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:30:26Z

Agupta27: /* Key changes */

=== 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:28:53Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:22:12Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-30T18:22:00Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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 students 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-03-30T18:20:16Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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, otherwise you can use the students listed in peer review information) 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-03-30T05:11:16Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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) 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-03-30T05:10:38Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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) for an active assignment. Active assignment simply means that the due date is in future and assignment is not in "Finished" 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-03-29T22:20:55Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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) for an active assignment. Active assignment simply means that the due date is in future.
You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due date 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-03-29T22:19:02Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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 steps can be performed to test this code from the UI:

''Before the test::'' Have two students in an assignment team (say student1 and student2) for an active assignment. Active assignment simply means that the due date is in future.
You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due date 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-03-29T22:13:41Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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 steps can be performed to test this code from UI:

''Before the test::'' Have two students in an assignment team (say student1 and student2) for an active assignment. Active assignment simply means that the due date is in future.
You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due date 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-03-29T22:12:33Z

Agupta27: /* Key changes */

=== 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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 steps can be performed to test this code from UI:

''Before the test::'' Have two students in an assignment team (say student1 and student2) for an active assignment. Active assignment simply means that the due date is in future.
You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due date 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 other team. Review should be submitted successfully.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-29T22:11:42Z

Agupta27: /* Key changes */

=== 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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 steps can be performed to test this code from UI:

''Before the test::'' Have two students in an assignment team (say student1 and student2) for an active assignment. Active assignment simply means that the due date is in future.
You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due date 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 other team. Review should be submitted successfully.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-29T22:10:15Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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 steps can be performed to test this code from UI:

''Before the test::'' Have two students in an assignment team (say student1 and student2) for an active assignment. Active assignment simply means that the due date is in future.
You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due date 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 other team. Review should be submitted successfully.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-29T22:08:44Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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 steps can be performed to test this code from UI:

''Before the test::'' Have two students in an assignment team (say student1 and student2) for an active assignment. Active assignment simply means that the due date is in future.
You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due date 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 other team. Review can be submitted successfully.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-29T22:07:51Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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 steps can be performed to test this code from UI:

''Before the test::'' Have two students in an assignment team (say student1 and student2) for an active assignment. Active assignment implies that due date is in that future.
You can use instructor login (example username: instructor6 password: password) to create a new assignment or update the due date of some previous assignment and assign student/teams 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 other team. Review can be submitted successfully.

CSC/ECE 517 Spring 2016/OSS E1601

2016-03-29T22:07:25Z

Agupta27: /* 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 ==

We suggest the reviewers to use the below students and instructor for the purpose of reviewing. These students belong to the same team and work on an assignment given 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 only be displayed to the enrolled students only before the assignment deadline.

== Expertiza Introduction==

Expertiza is an open source web application which enhances 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 student submitted files and hyperlinks, that content was submitted on behalf of a team, not individuals (even there is only one person in the team). Some of the previous contributors worked on a project which associated all the submitted content to teams: there were submitted_hyperlinks and dirctory_num fields in teams table. All the hyperlinks should ideally be recorded in one submitted_hyperlinks field. All the submitted files were uploaded to the 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 look like the author submitted the hyperlinks on behalf of him/herself. They should be moved to assignment_teams.rb.

'''What refactoring we have done to improve''':
* Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.
* Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

* Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.
* All the calls to the above methods were refactored to call the appropriate method's functions.
* Wrote 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. 

1) 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>

2) 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.

3) 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>

4) Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, 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.

5) 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 steps needs to be performed to test this code from UI:

''Before the test::'' Have two students in an assignment team (say student1 and student2) for an active assignment. Active assignment implies that due date is in that future.
You can use instructor login (example username: instructor6 password: password) to create a new assignment or update the due date of some previous assignment and assign student/teams 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 other team. Review can be submitted successfully.