Expertiza_Wiki - User contributions [en]

File:UMLstep2-517project.png

2016-04-11T22:43:20Z

Sshaikh2:

M1606: Implementing HTTP authorization UI and persistent sessions

2016-04-11T22:40:50Z

Sshaikh2:

''' M1606: Implementing HTTP authorization UI and persistent sessions '''

[https://en.wikipedia.org/wiki/Web_page Web pages] make use of [https://en.wikipedia.org/wiki/Session_(computer_science) sessions] all the time. These are required to persist throughout the life of the user's interaction with the web site or web application.This is supported by Servo as of today. However it doesn't support the persistence of data upon the closing and reopening of the web browser.<ref> https://github.com/servo/servo/wiki/Persistent-sessions-student-project</ref>

With this project we aim to create the necessary infrastructure to support this.

== '''Introduction''' ==

=== Servo ===

[https://en.wikipedia.org/wiki/Servo_(layout_engine) Servo] is a web browser layout engine written in Rust and is currently being developed by Mozilla Research. The aim of the project is not to create a full browser but is rather to create a highly parallel environment that allows for many components be handled by fine-grained, isolated tasks.
Servo is built on top of Rust to provide a secure and reliable foundation and is focused on creating a reliable and fast browser engine.<ref>https://en.wikipedia.org/wiki/Servo_(layout_engine)</ref>

=== Rust ===

[http://doc.rust-lang.org/book/README Rust] is a multi-paradigm, compiled programming language that is a good language for creating highly safe systems. Rust and Servo have a symbiotic relationship as the development of servo has influenced the design of the language.
Rust is a modern, fast, memory safe and multithreaded programming language that focuses on speed and safety for developing reliable and efficient systems. It eliminates all data races by having numerous compile-time safety checks that adds no runtime overhead.<ref>https://en.wikipedia.org/wiki/Rust_(programming_language)</ref>

== '''Previous Related Work''' ==

'''A Wiki Page regarding this work can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_OSS_M1606 here ]'''

1) Added a new command line flag <code> --profile-dir [path]</code> that stores an optional directory path in the Opts struct in <code>opts.rs</code>, creates the directory if it does not exist.

[[File:Step2Wiki2spring16.jpg]]

2) Created [http://doc.rust-lang.org/book/ffi.html Rust FFI bindings] for the <code>[https://github.com/jdm/tinyfiledialogs tinyfiledialogs] </code>library to allow calling the C methods from Servo.

[[File:Step3-1Wiki2spring16.jpg]]

[[File:Step3-2Wiki2spring16.jpg]]

3) In <code>resource_thread.rs</code>, defined an HTTP authorization cache storage (username, password, URL) and instantiated it like the cookie_storage member (inside an <code>Arc<Rwlock<>></code> value, to enable sharing it between threads).

[[File:Step4Wiki2spring16.jpg]]

4) In <code>modify_request_headers</code> in <code>http_loader.rs</code>, implemented the remaining pieces of step 12 of the [https://fetch.spec.whatwg.org/#http-network-or-cache-fetch appropriate specification ] using the authorization cache.

[[File:Step5Wiki2spring16.jpg]]

== '''Scope''' ==
The scope of the project comprises of the 4 steps listed below:

1) Ensure the appearance of an authorization UI in case a [https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html 401 HTTP response] is received. In load in the [https://github.com/servo/servo/blob/master/components/net/http_loader.rs http_loader.rs], immediately before attempting to process an HTTP redirection, the new [https://sourceforge.net/projects/tinyfiledialogs/ tinyfiledialogs] is made use of to make two prompts to pop up (for username and password), subsequently the request is restarted and the new authorization value present applied. If an authorization value was indeed present and the response is successful, the credentials are added to the authorization cache.

2) If the command-line option of the profile directory is present when the ResourceThread is instructed to exit, the data contained in the cookie_storage, hsts_list, and the new HTTP authorization cache is serialized. This serialized data is then written in separate files inside the profile directory.

3) Perform similar serialization upon shutdown for local_data in [https://doc.servo.org/src/net_traits/storage_thread.rs.html storage_thread.rs], which represents the LocalStorage API.

4) Check if the command-line option is present in the profile directory in the ResourceThreadconstructor and look for files that will contain serialized versions of the previous steps. If such files do exist, populate the appropriate fields with deserialized versions of the file’s contents.

== '''Design Patterns''' ==
The team was not given much freedom for design patterns. We followed and used the existing servo design strategy. You can read about the servo design [https://github.com/servo/servo/wiki/Design here]

We do use a facade pattern by creating a safe RUST wrapper around the RUST FFI for the tinyfiledialogs library that we will use for the UI. We could have just called the FFI functions from servo, but instead we created a safe and simple interface to call the library functions.

== '''Implementation / Design Decisions''' ==

Here are some of the design decisions that we have made for implementing the steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/M1606:_Implementing_HTTP_authorization_UI_and_persistent_sessions#Scope Scope] :

=== Step 1 ===

Objective: Make an authorization UI appear when a 401 HTTP response is received

Using the tinyfiledialogs RUST FFI bindings that the team created in the initial steps we will create a UI for the user to enter his username and password when a 401 request is received for a basic HTTP authentication. We will first check if the status code of the http response is "unauthorized". If the code is unauthorized we will display the UI for the user to enter his username and password. After the username and password are entered the request is restarted with the authentication header added. If the request is now successful we create a new authentication entry struct and place it into the Authentication hash map for future use.

=== Step 2 ===

Objective: On shutdown serialize the data contained in cookie_storage, hsts_list, and the new HTTP authorization cache, and write the serialized data in separate files inside the profile directory.

When a Resource Thread exits we will check if the opts structure located in opts.rs contains an entry for the command line option "--profile dir". If the option is present when the Resource Thread exits we will open or create a file for each data set we are saving. After each file is opened or created we will serialize the data that corresponds to that file with the rust serialize library and save the serialized data to the file.

=== Step 3 ===

Objective: On shutdown serialize the local_data in storage_thread.r

This is similar to step 2 and some code re-use will be used. However, the difference between this step and step 2 is that the local data contained in storage_thread.rs will be the data that is being serialized and saved into the same directory.

=== Step 4 ===

Objective: If the command line option for profile-dir is present then load the serialized data present in the directory that is given.

When a resource thread is created we will check if the opts structure located in opts.rs contains a entry for the command line option "--profile dir". If the option is present then the data from each file contained in the directory will be opened and deserialized using the serialize rust library. The data will then be placed in the appropriate fields. i.e (cookie_storage, hsts_lists, authorization_cache)

=='''UML Diagrams'''==

==='''UML for step 1'''===

[[File:517project.png ]]

==='''UML for step 2'''===

[[File:download (1).png]]

==='''UML for step 4'''===

[[File:517project.png ]]

=='''Testing'''==

===Testing the new command line flag --profile-dir===

Steps for Testing the new command line flag --profile-dir can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_OSS_M1606#Testing_the_new_command_line_flag_--profile-dir here]

=== Unit Test for set authorization header if url does not have credentials ===

Steps for Unit Tests for set authorization header if url does not have credentials can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_OSS_M1606#Unit_Test_for_set_authorization_header_if_url_does_not_have_credentials here]

=== GUI test for the tinyfiledialogs lib ===

Steps for GUI test for the tinyfiledialogs lib can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_OSS_M1606#GUI_test_for_the_tinyfiledialogs_lib here ]

=='''References'''==
<references/>

M1606: Implementing HTTP authorization UI and persistent sessions

2016-04-11T21:21:32Z

Sshaikh2: typo corrected

''' M1606: Implementing HTTP authorization UI and persistent sessions '''

[https://en.wikipedia.org/wiki/Web_page Web pages] make use of [https://en.wikipedia.org/wiki/Session_(computer_science) sessions] all the time. These are required to persist throughout the life of the user's interaction with the web site or web application.This is supported by Servo as of today. However it doesn't support the persistence of data upon the closing and reopening of the web browser.<ref> https://github.com/servo/servo/wiki/Persistent-sessions-student-project</ref>

With this project we aim to create the necessary infrastructure to support this.

== '''Introduction''' ==

=== Servo ===

[https://en.wikipedia.org/wiki/Servo_(layout_engine) Servo] is a web browser layout engine written in Rust and is currently being developed by Mozilla Research. The aim of the project is not to create a full browser but is rather to create a highly parallel environment that allows for many components be handled by fine-grained, isolated tasks.
Servo is built on top of Rust to provide a secure and reliable foundation and is focused on creating a reliable and fast browser engine.<ref>https://en.wikipedia.org/wiki/Servo_(layout_engine)</ref>

=== Rust ===

[http://doc.rust-lang.org/book/README Rust] is a multi-paradigm, compiled programming language that is a good language for creating highly safe systems. Rust and Servo have a symbiotic relationship as the development of servo has influenced the design of the language.
Rust is a modern, fast, memory safe and multithreaded programming language that focuses on speed and safety for developing reliable and efficient systems. It eliminates all data races by having numerous compile-time safety checks that adds no runtime overhead.<ref>https://en.wikipedia.org/wiki/Rust_(programming_language)</ref>

== '''Previous Related Work''' ==

'''A Wiki Page regarding this work can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_OSS_M1606 here ]'''

1) Added a new command line flag <code> --profile-dir [path]</code> that stores an optional directory path in the Opts struct in <code>opts.rs</code>, creates the directory if it does not exist.

[[File:Step2Wiki2spring16.jpg]]

2) Created [http://doc.rust-lang.org/book/ffi.html Rust FFI bindings] for the <code>[https://github.com/jdm/tinyfiledialogs tinyfiledialogs] </code>library to allow calling the C methods from Servo.

[[File:Step3-1Wiki2spring16.jpg]]

[[File:Step3-2Wiki2spring16.jpg]]

3) In <code>resource_thread.rs</code>, defined an HTTP authorization cache storage (username, password, URL) and instantiated it like the cookie_storage member (inside an <code>Arc<Rwlock<>></code> value, to enable sharing it between threads).

[[File:Step4Wiki2spring16.jpg]]

4) In <code>modify_request_headers</code> in <code>http_loader.rs</code>, implemented the remaining pieces of step 12 of the [https://fetch.spec.whatwg.org/#http-network-or-cache-fetch appropriate specification ] using the authorization cache.

[[File:Step5Wiki2spring16.jpg]]

== '''Scope''' ==
The scope of the project comprises of the 4 steps listed below:

1) Ensure the appearance of an authorization UI in case a [https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html 401 HTTP response] is received. In load in the [https://github.com/servo/servo/blob/master/components/net/http_loader.rs http_loader.rs], immediately before attempting to process an HTTP redirection, the new [https://sourceforge.net/projects/tinyfiledialogs/ tinyfiledialogs] is made use of to make two prompts to pop up (for username and password), subsequently the request is restarted and the new authorization value present applied. If an authorization value was indeed present and the response is successful, the credentials are added to the authorization cache.

2) If the command-line option of the profile directory is present when the ResourceThread is instructed to exit, the data contained in the cookie_storage, hsts_list, and the new HTTP authorization cache is serialized. This serialized data is then written in separate files inside the profile directory.

3) Perform similar serialization upon shutdown for local_data in [https://doc.servo.org/src/net_traits/storage_thread.rs.html storage_thread.rs], which represents the LocalStorage API.

4) Check if the command-line option is present in the profile directory in the ResourceThreadconstructor and look for files that will contain serialized versions of the previous steps. If such files do exist, populate the appropriate fields with deserialized versions of the file’s contents.

== '''Design Patterns''' ==
The team was not given much freedom for design patterns. We followed and used the existing servo design strategy. You can read about the servo design [https://github.com/servo/servo/wiki/Design here]

We do use a facade pattern by creating a safe RUST wrapper around the RUST FFI for the tinyfiledialogs library that we will use for the UI. We could have just called the FFI functions from servo, but instead we created a safe and simple interface to call the library functions.

== '''Implementation / Design Decisions''' ==

Here are some of the design decisions that we have made for implementing the steps mentioned in [http://wiki.expertiza.ncsu.edu/index.php/M1606:_Implementing_HTTP_authorization_UI_and_persistent_sessions#Scope Scope] :

=== Step 1 ===

Objective: Make an authorization UI appear when a 401 HTTP response is received

Using the tinyfiledialogs RUST FFI bindings that the team created in the initial steps we will create a UI for the user to enter his username and password when a 401 request is received for a basic HTTP authentication. We will first check if the status code of the http response is "unauthorized". If the code is unauthorized we will display the UI for the user to enter his username and password. After the username and password are entered the request is restarted with the authentication header added. If the request is now successful we create a new authentication entry struct and place it into the Authentication hash map for future use.

=== Step 2 ===

Objective: On shutdown serialize the data contained in cookie_storage, hsts_list, and the new HTTP authorization cache, and write the serialized data in separate files inside the profile directory.

When a Resource Thread exits we will check if the opts structure located in opts.rs contains an entry for the command line option "--profile dir". If the option is present when the Resource Thread exits we will open or create a file for each data set we are saving. After each file is opened or created we will serialize the data that corresponds to that file with the rust serialize library and save the serialized data to the file.

=== Step 3 ===

Objective: On shutdown serialize the local_data in storage_thread.r

This is similar to step 2 and some code re-use will be used. However, the difference between this step and step 2 is that the local data contained in storage_thread.rs will be the data that is being serialized and saved into the same directory.

=== Step 4 ===

Objective: If the command line option for profile-dir is present then load the serialized data present in the directory that is given.

When a resource thread is created we will check if the opts structure located in opts.rs contains a entry for the command line option "--profile dir". If the option is present then the data from each file contained in the directory will be opened and deserialized using the serialize rust library. The data will then be placed in the appropriate fields. i.e (cookie_storage, hsts_lists, authorization_cache)

=='''UML for step 1'''==
[[File:517project.png ]]

=='''Testing'''==

===Testing the new command line flag --profile-dir===

Steps for Testing the new command line flag --profile-dir can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_OSS_M1606#Testing_the_new_command_line_flag_--profile-dir here]

=== Unit Test for set authorization header if url does not have credentials ===

Steps for Unit Tests for set authorization header if url does not have credentials can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_OSS_M1606#Unit_Test_for_set_authorization_header_if_url_does_not_have_credentials here]

=== GUI test for the tinyfiledialogs lib ===

Steps for GUI test for the tinyfiledialogs lib can be found [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2016_OSS_M1606#GUI_test_for_the_tinyfiledialogs_lib here ]

=='''References'''==
<references/>

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-04-02T03:36:50Z

Sshaikh2: /* Testing from UI */

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Refactored has_submissions? In Assignment Team to :
<pre>
def has_submissions?
(self.submitted_files.length > 0) or self.submitted_hyperlinks.blank?
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*add_participant in course_team.rb.
*participant_type in assignment_team.rb.
*assignment in team.rb.
*email method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*self.first_member(team_id): Shows if a team is empty or not.
*set_student_directory_number: Sets the team to submission relation.

==== Pretty-Printing the code ====
*Deleted unnecessary white spaces, and pretty printed the whole code in all the 3 classes.
*Debugged and figured out the usage of every method in the classes and have provided small comments for reader to understand the operation of the defined method.

=== Testing from UI ===
This project deals entirely with the creation, deletion, modification, import and export of teams on Expertiza. Following is the step-by-step guide to test functionalities.

For testing, the following parameters can be used:

'''For Admin:'''

Username: administrator5

Password: password

'''For Student:'''

Username: student5884

Password: password

Username: student6420

Password: password

====Creating teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to create new team.

5) Fill in the required details and save the team.

6) Verify whether the new team has been created.

====Exporting teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to export all the teams.

5) Verify whether .csv file was successfully exported to the system.

====Importing teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to import new team.

5) Select the .csv file from the system and click on import.

6) Verify whether import was successful.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/nikraina/expertiza.git GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#[http://ruby-doc.org/ Ruby Documentation]
#[https://sourcemaking.com/design_patterns/prototype Prototype Pattern]

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-04-02T03:18:55Z

Sshaikh2: /* Testing from UI */

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Refactored has_submissions? In Assignment Team to :
<pre>
def has_submissions?
(self.submitted_files.length > 0) or self.submitted_hyperlinks.blank?
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*add_participant in course_team.rb.
*participant_type in assignment_team.rb.
*assignment in team.rb.
*email method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*self.first_member(team_id): Shows if a team is empty or not.
*set_student_directory_number: Sets the team to submission relation.

==== Pretty-Printing the code ====
*Deleted unnecessary white spaces, and pretty printed the whole code in all the 3 classes.
*Debugged and figured out the usage of every method in the classes and have provided small comments for reader to understand the operation of the defined method.

=== Testing from UI ===
This project deals entirely with the creation, deletion, modification, import and export of teams on Expertiza. Following is the step-by-step guide to test functionalities.

For testing, the following parameters can be used:

'''For Admin:'''

Username: administrator5

Password: password

'''For Student:'''

Username: student5884

Password: password

Username: student6420

Password: password

====Creating teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to create new team.

5) Fill in the required details and save the team.

6) Verify whether the new team has been created.

====Importing teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to import new team.

5) Select the .csv file from the system and click on import.

6) Verify whether import was successful.

====Exporting teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to export all the teams.

5) Verify whether .csv file was successfully exported to the system.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/nikraina/expertiza.git GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#[http://ruby-doc.org/ Ruby Documentation]
#[https://sourcemaking.com/design_patterns/prototype Prototype Pattern]

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-04-02T03:18:12Z

Sshaikh2: /* Testing from UI */

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Refactored has_submissions? In Assignment Team to :
<pre>
def has_submissions?
(self.submitted_files.length > 0) or self.submitted_hyperlinks.blank?
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*add_participant in course_team.rb.
*participant_type in assignment_team.rb.
*assignment in team.rb.
*email method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*self.first_member(team_id): Shows if a team is empty or not.
*set_student_directory_number: Sets the team to submission relation.

==== Pretty-Printing the code ====
*Deleted unnecessary white spaces, and pretty printed the whole code in all the 3 classes.
*Debugged and figured out the usage of every method in the classes and have provided small comments for reader to understand the operation of the defined method.

=== Testing from UI ===
This project deals entirely with the creation, deletion, modification, import and export of teams on Expertiza. Following is the step-by-step guide to test functionalities.

For testing, the following parameters can be used:

[[For Admin:]]

Username: administrator5

Password: password

[[For Student:]]

Username: student5884

Password: password

Username: student6420

Password: password

====Creating teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to create new team.

5) Fill in the required details and save the team.

6) Verify whether the new team has been created.

====Importing teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to import new team.

5) Select the .csv file from the system and click on import.

6) Verify whether import was successful.

====Exporting teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to export all the teams.

5) Verify whether .csv file was successfully exported to the system.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/nikraina/expertiza.git GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#[http://ruby-doc.org/ Ruby Documentation]
#[https://sourcemaking.com/design_patterns/prototype Prototype Pattern]

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-04-02T03:17:34Z

Sshaikh2: /* Testing from UI */

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Refactored has_submissions? In Assignment Team to :
<pre>
def has_submissions?
(self.submitted_files.length > 0) or self.submitted_hyperlinks.blank?
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*add_participant in course_team.rb.
*participant_type in assignment_team.rb.
*assignment in team.rb.
*email method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*self.first_member(team_id): Shows if a team is empty or not.
*set_student_directory_number: Sets the team to submission relation.

==== Pretty-Printing the code ====
*Deleted unnecessary white spaces, and pretty printed the whole code in all the 3 classes.
*Debugged and figured out the usage of every method in the classes and have provided small comments for reader to understand the operation of the defined method.

=== Testing from UI ===
This project deals entirely with the creation, deletion, modification, import and export of teams on Expertiza. Following is the step-by-step guide to test functionalities.

For testing, the following parameters can be used:

For Admin:

Username: administrator5

Password: password

For Student:

Username: student5884

Password: password

Username: student6420

Password: password

====Creating teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to create new team.

5) Fill in the required details and save the team.

6) Verify whether the new team has been created.

====Importing teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to import new team.

5) Select the .csv file from the system and click on import.

6) Verify whether import was successful.

====Exporting teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to export all the teams.

5) Verify whether .csv file was successfully exported to the system.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/nikraina/expertiza.git GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#[http://ruby-doc.org/ Ruby Documentation]
#[https://sourcemaking.com/design_patterns/prototype Prototype Pattern]

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-04-02T03:17:17Z

Sshaikh2: /* Testing from UI */

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Refactored has_submissions? In Assignment Team to :
<pre>
def has_submissions?
(self.submitted_files.length > 0) or self.submitted_hyperlinks.blank?
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*add_participant in course_team.rb.
*participant_type in assignment_team.rb.
*assignment in team.rb.
*email method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*self.first_member(team_id): Shows if a team is empty or not.
*set_student_directory_number: Sets the team to submission relation.

==== Pretty-Printing the code ====
*Deleted unnecessary white spaces, and pretty printed the whole code in all the 3 classes.
*Debugged and figured out the usage of every method in the classes and have provided small comments for reader to understand the operation of the defined method.

=== Testing from UI ===
This project deals entirely with the creation, deletion, modification, import and export of teams on Expertiza. Following is the step-by-step guide to test functionalities.

For testing, the following parameters can be used:

For Admin:

Username: administrator5
Password: password

For Student:

Username: student5884
Password: password

Username: student6420
Password: password

====Creating teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to create new team.

5) Fill in the required details and save the team.

6) Verify whether the new team has been created.

====Importing teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to import new team.

5) Select the .csv file from the system and click on import.

6) Verify whether import was successful.

====Exporting teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to export all the teams.

5) Verify whether .csv file was successfully exported to the system.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/nikraina/expertiza.git GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#[http://ruby-doc.org/ Ruby Documentation]
#[https://sourcemaking.com/design_patterns/prototype Prototype Pattern]

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-04-02T03:15:55Z

Sshaikh2: /* Testing from UI */

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Refactored has_submissions? In Assignment Team to :
<pre>
def has_submissions?
(self.submitted_files.length > 0) or self.submitted_hyperlinks.blank?
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*add_participant in course_team.rb.
*participant_type in assignment_team.rb.
*assignment in team.rb.
*email method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*self.first_member(team_id): Shows if a team is empty or not.
*set_student_directory_number: Sets the team to submission relation.

==== Pretty-Printing the code ====
*Deleted unnecessary white spaces, and pretty printed the whole code in all the 3 classes.
*Debugged and figured out the usage of every method in the classes and have provided small comments for reader to understand the operation of the defined method.

=== Testing from UI ===
This project deals entirely with the creation, deletion, modification, import and export of teams on Expertiza. Following is the step-by-step guide to test functionalities.

For testing, the following parameters can be used:

For Admin:
Username: administrator5
Password: password

For Student:
Username: student5884
Password: password

Username: student6420
Password: password

====Creating teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to create new team.

5) Fill in the required details and save the team.

6) Verify whether the new team has been created.

====Importing teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to import new team.

5) Select the .csv file from the system and click on import.

6) Verify whether import was successful.

====Exporting teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to export all the teams.

5) Verify whether .csv file was successfully exported to the system.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/nikraina/expertiza.git GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#[http://ruby-doc.org/ Ruby Documentation]
#[https://sourcemaking.com/design_patterns/prototype Prototype Pattern]

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-04-01T17:48:06Z

Sshaikh2: /* Testing from UI */

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Refactored has_submissions? In Assignment Team to :
<pre>
def has_submissions?
(self.submitted_files.length > 0) or self.submitted_hyperlinks.blank?
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*add_participant in course_team.rb.
*participant_type in assignment_team.rb.
*assignment in team.rb.
*email method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*self.first_member(team_id): Shows if a team is empty or not.
*set_student_directory_number: Sets the team to submission relation.

==== Pretty-Printing the code ====
*Deleted unnecessary white spaces, and pretty printed the whole code in all the 3 classes.
*Debugged and figured out the usage of every method in the classes and have provided small comments for reader to understand the operation of the defined method.

=== Testing from UI ===
This project deals entirely with the creation, deletion, modification, import and export of teams on Expertiza. Following is the step-by-step guide to test functionalities.

For testing, the following parameters can be used:

For Admin:
Username: administrator5
Password: password

For Student:
Username: student16
Password: password

Username: student18
Password: password

====Creating teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to create new team.

5) Fill in the required details and save the team.

6) Verify whether the new team has been created.

====Importing teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to import new team.

5) Select the .csv file from the system and click on import.

6) Verify whether import was successful.

====Exporting teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to export all the teams.

5) Verify whether .csv file was successfully exported to the system.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/nikraina/expertiza.git GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#[http://ruby-doc.org/ Ruby Documentation]
#[https://sourcemaking.com/design_patterns/prototype Prototype Pattern]

User:Sshaikh2

2016-03-24T02:29:17Z

Sshaikh2: moved User:Sshaikh2 to CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

#REDIRECT [[CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb]]

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T02:29:17Z

Sshaikh2: moved User:Sshaikh2 to CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Refactored has_submissions? In Assignment Team to :
<pre>
def has_submissions?
(self.submitted_files.length > 0) or self.submitted_hyperlinks.blank?
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*add_participant in course_team.rb.
*participant_type in assignment_team.rb.
*assignment in team.rb.
*email method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*self.first_member(team_id): Shows if a team is empty or not.
*set_student_directory_number: Sets the team to submission relation.

==== Pretty-Printing the code ====
*Deleted unnecessary white spaces, and pretty printed the whole code in all the 3 classes.
*Debugged and figured out the usage of every method in the classes and have provided small comments for reader to understand the operation of the defined method.

=== Testing from UI ===
This project deals entirely with the creation, deletion, modification, import and export of teams on Expertiza. Following is the step-by-step guide to test functionalities.

====Creating teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to create new team.

5) Fill in the required details and save the team.

6) Verify whether the new team has been created.

====Importing teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to import new team.

5) Select the .csv file from the system and click on import.

6) Verify whether import was successful.

====Exporting teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to export all the teams.

5) Verify whether .csv file was successfully exported to the system.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/nikraina/expertiza.git GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#[http://ruby-doc.org/ Ruby Documentation]
#[https://sourcemaking.com/design_patterns/prototype Prototype Pattern]

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T02:18:41Z

Sshaikh2:

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Refactored has_submissions? In Assignment Team to :
<pre>
def has_submissions?
(self.submitted_files.length > 0) or self.submitted_hyperlinks.blank?
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*add_participant in course_team.rb.
*participant_type in assignment_team.rb.
*assignment in team.rb.
*email method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*self.first_member(team_id): Shows if a team is empty or not.
*set_student_directory_number: Sets the team to submission relation.

==== Pretty-Printing the code ====
*Deleted unnecessary white spaces, and pretty printed the whole code in all the 3 classes.
*Debugged and figured out the usage of every method in the classes and have provided small comments for reader to understand the operation of the defined method.

=== Testing from UI ===
This project deals entirely with the creation, deletion, modification, import and export of teams on Expertiza. Following is the step-by-step guide to test functionalities.

====Creating teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to create new team.

5) Fill in the required details and save the team.

6) Verify whether the new team has been created.

====Importing teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to import new team.

5) Select the .csv file from the system and click on import.

6) Verify whether import was successful.

====Exporting teams====

1) Login in with administrator.

2) Go to course/assignment tab.

3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.

4) On the bottom of the page, there is a link to export all the teams.

5) Verify whether .csv file was successfully exported to the system.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/nikraina/expertiza.git GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#[http://ruby-doc.org/ Ruby Documentation]
#[https://sourcemaking.com/design_patterns/prototype Prototype Pattern]

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T02:17:28Z

Sshaikh2:

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Refactored has_submissions? In Assignment Team to :
<pre>
def has_submissions?
(self.submitted_files.length > 0) or self.submitted_hyperlinks.blank?
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*add_participant in course_team.rb.
*participant_type in assignment_team.rb.
*assignment in team.rb.
*email method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*self.first_member(team_id): Shows if a team is empty or not.
*set_student_directory_number: Sets the team to submission relation.

==== Pretty-Printing the code ====
*Deleted unnecessary white spaces, and pretty printed the whole code in all the 3 classes.
*Debugged and figured out the usage of every method in the classes and have provided small comments for reader to understand the operation of the defined method.

=== Testing from UI ===
This project deals entirely with the creation, deletion, modification, import and export of teams on Expertiza. Following is the step-by-step guide to test functionalities.

====Creating teams===
1) Login in with administrator.
2) Go to course/assignment tab.
3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.
4) On the bottom of the page, there is a link to create new team.
5) Fill in the required details and save the team.
6) Verify whether the new team has been created.

====Importing teams===
1) Login in with administrator.
2) Go to course/assignment tab.
3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.
4) On the bottom of the page, there is a link to import new team.
5) Select the .csv file from the system and click on import.
6) Verify whether import was successful.

====Exporting teams===
1) Login in with administrator.
2) Go to course/assignment tab.
3) Click on create team against the desired course/assignment, it will redirect to a new page where all the teams are displayed.
4) On the bottom of the page, there is a link to export all the teams.
5) Verify whether .csv file was successfully exported to the system.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/nikraina/expertiza.git GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#[http://ruby-doc.org/ Ruby Documentation]
#[https://sourcemaking.com/design_patterns/prototype Prototype Pattern]

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:59:13Z

Sshaikh2:

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:56:37Z

Sshaikh2:

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*add_participant in course_team.rb.
*participant_type in assignment_team.rb.
*assignment in team.rb.
*email method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*self.first_member(team_id): Shows if a team is empty or not.
*set_student_directory_number: Sets the team to submission relation.

=== Testing from UI ===

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:54:30Z

Sshaikh2:

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

===Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

=== System Design ===
This project deals with the "team" module of Expertiza which handles the creation of teams and other aspects related to teams like submission, importing and exporting. Expertiza has 3 models, team.rb, course_team.rb and assignment_team.rb for teams in general, teams for a course and teams for each assignment.

The design specific to these models is as follows::

Here the course_team and assignment_team are subclasses of team. The parent_id field in the database of teams refer to the id of course or assignment based on the type for which it was created. Hence in course_team instances the parent_id contains the course ID and for assignment_team the parent_id contains the assignment ID.
The main table stores the team members is TeamUsers, where each line is uniquely identified by the user_id and the team_id. This table is linked to Team, Participant & Users.

The understanding of this system design is core to understanding the functionality of team.rb, course_team.rb and assignment_team.rb models.

=== Solutions Provided ===
====Refactoring ====

'''Import''' :This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.import(row, id, options,teamtype)
raise ArgumentError, "Not enough fields on this line" if (row.length < 2 && options[:has_column_names] == "true") || (row.length < 1 && options[:has_column_names] != "true")

if options[:has_column_names] == "true"
name = row[0].to_s.strip
team = where(["name =? && parent_id =?", name, id]).first
team_exists = !team.nil?
name = handle_duplicate(team, name, id, options[:handle_dups],teamtype)
index = 1
else
if teamtype.is_a?(CourseTeam)
name = self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
name = self.generate_team_name(Assignment.find(id).name)
end
index = 0
end

if name
team = Team.create_team_and_node(id,teamtype)
team.name = name
team.save
end

# insert team members into team unless team was pre-existing & we ignore duplicate teams
team.import_team_members(index, row) if !(team_exists && options[:handle_dups] == "ignore")
end
</pre>

'''Export ''':This method was refactored to the parent class team.rb from the assignment_team.rb and the course_team.rb. The new code is :

<pre>
def self.export(csv, parent_id, options, teamtype)
if teamtype.is_a?(CourseTeam)
teams = CourseTeam.where(["parent_id =?", parent_id])
elsif teamtype.is_a?(AssignmentTeam)
teams = AssignmentTeam.where(["parent_id =?", parent_id])
end
teams.each do |team|
output = Array.new
output.push(team.name)
if options["team_name"] == "false"
team_members = TeamsUser.where(['team_id = ?', team.id])
team_members.each do |user|
output.push(user.name)
end
end
output.push(teams.name)
csv << output
end
end
</pre>

'''Helper Methods''': Some of the helper methods also had to be refactored to the parent class.

<pre>
def self.create_team_and_node(id,teamtype)
if teamtype.is_a?(CourseTeam)
curr_course = Course.find(id)
team_name = Team.generate_team_name(curr_course.name)
team = CourseTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
elsif teamtype.is_a?(AssignmentTeam)
curr_assignment = Assignment.find(id)
team_name = Team.generate_team_name(curr_assignment.name)
team = AssignmentTeam.create(name: team_name, parent_id: id)
TeamNode.create(parent_id: id, node_object_id: team.id)
end
team
end
</pre>

<pre>
def self.handle_duplicate(team, name, id, handle_dups, teamtype)
if team.nil? #no duplicate
return name
end
if handle_dups == "ignore" #ignore: do not create the new team
p '>>>setting name to nil ...'
return nil
end
if handle_dups == "rename" #rename: rename new team
if teamtype.is_a?(CourseTeam)
return self.generate_team_name(Course.find(id).name)
elsif teamtype.is_a?(AssignmentTeam)
return self.generate_team_name(Assignment.find(id).name)
end
end
if handle_dups == "replace" #replace: delete old team
team.delete
return name
else # handle_dups = "insert"
return nil
end
end

</pre>

Changes to the child classes:
<pre>
def self.prototype
AssignmentTeam.new
end
</pre>
<pre>
def self.prototype
CourseTeam.new
end
</pre>

Prototype Design Pattern is an ideal fit to handle this child parent relationship, but prototype pattern one needs to clone the child objects and then pass them to the parent’s calling method. But since Ruby allows for deep copy but does not allow for cloning objects, this is not possible. Hence a similar behavior has been simulated by creating objects in child classes and passing them as parameters to the parent class. A prototype method is defined in child classes that returns an object of that class which is then passed to the parent where reflection is used to identify the source calling method and act based on it.

==== Deleting Deprecated Methods ====

The following methods have been deleted as they are not in use anymore:
*<pre>add_participant</pre> in course_team.rb.
*<pre>participant_type</pre> in assignment_team.rb.
*<pre>assignment</pre> in team.rb.
*<pre>email</pre> method was removed.

The following methods were not removed as they are still used elsewhere in the code:
*<pre>self.first_member(team_id)</pre>: Shows if a team is empty or not.
*<pre>set_student_directory_number</pre>: Sets the team to submission relation.

=== Testing from UI ===

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:42:04Z

Sshaikh2:

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:40:46Z

Sshaikh2:

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:38:05Z

Sshaikh2:

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:36:08Z

Sshaikh2:

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:21:18Z

Sshaikh2:

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:19:48Z

Sshaikh2:

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:09:20Z

Sshaikh2:

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:08:29Z

Sshaikh2:

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

== Introduction to Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.

----

The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T01:07:12Z

Sshaikh2:

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

== Introduction to Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.
The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
*Move the create_team_and_method to superclass (team.rb).
*Delete deprecated methods.
*Rewrite the method for checking if a team has submission.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T00:58:55Z

Sshaikh2:

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

__TOC__

== Introduction to Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is an [https://en.wikipedia.org/wiki/Open-source_software open source project] developed on [http://rubyonrails.org/ Ruby on Rails] framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

===Problem Statement===
The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations.
The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

===Tasks Identified===
The following tasks were accomplished in this project:

* Improved the clarity of code by improving the variable and parameter names.
* Long character strings were taken and given appropriate names.
* Handled pagination by a separate helper module, which can be used by multiple controllers.
* Implemented action_allowed for access_control to prevent unauthorized access of methods.
* Prevented displaying of all versions for all users and tables when a user views the index page.
* Added missing CRUD methods to Versions Controller
* Added RSPEC testcases for testing changes done in Versions Controller

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T00:53:52Z

Sshaikh2:

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T00:52:22Z

Sshaikh2: /* Introduction to Expertiza */

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

== Introduction to Expertiza ==

[Expertiza] is an [open open source, https://en.wikipedia.org/wiki/Open-source_software] project developed on Ruby on Rails framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T00:51:54Z

Sshaikh2: /* Introduction to Expertiza */

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

== Introduction to Expertiza ==

[Expertiza] is an open open source [https://en.wikipedia.org/wiki/Open-source_software] project developed on Ruby on Rails framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T00:51:34Z

Sshaikh2:

== E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the Expertiza based OSS project on refactoring.

== Introduction to Expertiza ==

[Expertiza] is an [open open source https://en.wikipedia.org/wiki/Open-source_software] project developed on Ruby on Rails framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T00:43:33Z

Sshaikh2:

== 1 E1611 Refactor team.rb, course_team.rb, and assignment_team.rb ==
This page provides the description of the EXpertia based OSS project on refactoring.

CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb

2016-03-24T00:41:29Z

Sshaikh2: Created page with " == askdhasd =="

== askdhasd ==