Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T05:03:20Z

Pdeka:

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby

=='''Reference'''==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T04:55:53Z

Pdeka:

== Introduction ==
Expertiza is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby

=='''Reference'''==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T04:54:38Z

Pdeka:

== Introduction ==
Expertiza is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

=='''Reference'''==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T04:50:29Z

Pdeka:

== Introduction ==
Expertiza is an open-source peer-review based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual peer-review mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

=='''Reference'''==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T04:42:43Z

Pdeka:

== Introduction ==
Expertiza is an open-source peer-review based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails<ref>https://en.wikipedia.org/wiki/Ruby_on_Rails</ref> framework and is supported by the National Science Foundation<ref>http://www.nsf.gov</ref>

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual peer-review mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

=='''Reference'''==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T04:20:37Z

Pdeka:

== Introduction ==
Expertiza is an open-source peer-review based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails framework and is supported by the National Science Foundation

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual peer-review mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

=='''Reference'''==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T04:17:16Z

Pdeka:

== Introduction ==
Expertiza is an open-source peer-review based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails framework and is supported by the National Science Foundation

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual peer-review mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

=='''Reference'''==
<references/>

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T06:47:19Z

Pdeka:

'''E1560. Refactoring PopUpController.rb and ParticipantsController.rb'''

This page provides a description of the Expertiza based OSS project. This project is aimed at refactoring PopUpController.rb and ParticipantsController.rb.

=Introduction to Expertiza=
[http://http://expertiza.ncsu.edu/ Expertiza] is an [http://en.wikipedia.org/wiki/Open-source_software Open Source] [http://rubyonrails.org/ Rails] application which is used by instructors and students for creating assignments and submitting peer reviews. Expertiza allows the instructor to create and customize assignments, create a list of topics the students can sign up for, have students work on teams and then review each other's assignments at the end. The Source code of the application can be cloned from [https://github.com/expertiza/expertiza/ Github].

=Project Desicription<ref>https://docs.google.com/document/d/1uWs3zyrupTmrOFuv5IbVWCF4NRvCXqJmg8dZ0wCqgus/edit</ref>=
'''Files involved:'''
popUpController.rb
participantsController.rb

'''What they do'''
PopUpController displays a review when a user (instructor or student) clicks on a list of reviews.
ParticipantsController handles participants in an assignment.

'''What's wrong with them:'''
PopUpController contains only two prominent methods, but they are very big.
ParticipantsController contains redundant code.

'''What needs to be done:'''
'''1 popUpController.rb'''
1.1 Action_allowed method always returns true. It needs to be fixed.
1.2 Team_user_popup method needs refactoring. @teamId is assigned but never used. Add comments to make code more readable. Rename variables based on their usage
1.3 Refactor Participants_popup and team_users_popup methods into smaller private methods.


'''2 participantsController.rb'''
2.1 In add and update_authorization methods, permissions collection object can be used to reference its elements without assigning each element to individual private variables.
2.2 Inherit and bequeath_all methods are similar. Common statements can be migrated to private method. Add comments in code to make it easy to understand.
2.3 Cluster all the flash messages under one private method to make the code more manageable
2.4 Fix email_sent method. It contains a dummy email address.

=Changes Made<ref>https://github.com/viveksubbarao/expertiza/commits/master</ref>=

=='''PopUpController.rb'''==
=== Modified <code>Action_allowed</code> method ===
Modified <code>Action_allowed</code> method to return true only if...
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def action_allowed?
true
end
</pre>
|<pre>
def action_allowed?
if @allowed_actions.include? params[:action]
true
else
false
end
end
</pre>
|}
=== Refactored <code>Team_user_popup</code> method ===
Removed unused instance variable @teamId
Changed redundant instance variables to local variables
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def team_users_popup
@sum = 0
@count = 0
@teamid = params[:id]
@team = Team.find(params[:id])
@assignment = Assignment.find(@team.parent_id)
@assignment_id = @assignment.id
@id=params[:assignment_id]
# @teamname = Team.find(params[:id]).name
@teamusers = TeamsUser.where(team_id: params[:id])

#id2 seems to be a response_map
if(params[:id2] == nil)
# if(@reviewid == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id:params[:id2]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:id2]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: @reviewid)

questionnaire =Response.find(@reviewid).questionnaire_by_answer(@scores.first)
@maxscore = questionnaire.max_question_score

if(@maxscore == nil)
@maxscore = 5
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end

# @review_questionnaire = Questionnaire.find(@assignment.review_questionnaire_id)
# @review_questions = @review_questionnaire.questions
#@maxscore = @review_questionnaire.max_question_score

end
</pre>
|<pre>
def team_users_popup
@sum = 0
@team = Team.find(params[:id])
@id = params[:assignment_id]
@teamusers = TeamsUser.where(team_id: params[:id])

puts params
# response_map id can be used to index into the Response
# table and find the desired response.
if (params[:response_map_id] == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id: params[:response_map_id]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:response_map_id]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: response.id)
questionnaire = Response.find(@reviewid).questionnaire_by_answer(@scores.first)

if (questionnaire.max_question_score == nil)
@maxscore = 5 # This instance variable is needed. It's used in the team_users_popup view.
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end
end
</pre>
|}

=== Refactored Participants_popup and team_users_popup methods into smaller private methods ===
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}



=='''ParticipantsController.rb'''==
=== Permissions collection object referenced directly in <code>add</code> and <code>update_authorization methods</code>===
Local variables like can_submit, can_review, etc removed and permissions object referenced directly
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
curr_object.add_participant(params[:user][:name],can_submit,can_review,can_take_quiz)
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => can_submit, :can_review => can_review, :can_take_quiz => can_take_quiz)
......
end
</pre>
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
curr_object.add_participant(params[:user][:name], permissions[:can_submit],
permissions[:can_review], permissions[:can_take_quiz])
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => permissions[:can_submit],
:can_review => permissions[:can_review], :can_take_quiz => permissions[:can_take_quiz])
......
end
</pre>
|}
=== Moved common functionality in <code>Inherit</code> and <code>bequeath_all</code> to private methods ===
Moved common functionality of <code>Inherit</code> and <code>bequeath_all</code> to private method <code>populate_copied_participants</code>
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def inherit
assignment = Assignment.find(params[:id])
course = assignment.course
@copied_participants = []

if course
participants = course.participants
if participants.length > 0
participants.each{|participant|
new_participant = participant.copy(params[:id])

if new_participant
@copied_participants.push new_participant
end
}

# Only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" has been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end

else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
@copied_participants = []
assignment = Assignment.find(params[:id])
if assignment.course
course = assignment.course
assignment.participants.each{ |participant|
new_participant = participant.copy(course.id)

if new_participant
@copied_participants.push new_participant
end
}
# only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". " )
else
flash[:note] = 'All assignment participants are already part of the course'
end

#flash[:note] = "All participants were successfully copied to \""+course.name+"\""
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end
</pre>
|<pre>
def inherit
assignment = Assignment.find(params[:id])

if assignment.course
if assignment.course.participants.length > 0
@copied_participants = populate_copied_participants(assignment.courses.participants, params[:id])
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" have been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end
else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
assignment = Assignment.find(params[:id])

if assignment.course
@copied_participants = populate_copied_participants(assignment.participants, assignment.course.id)
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". ")
else
flash[:note] = 'All assignment participants are already part of the course'
end
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def populate_copied_participants(participants, val)
@copied_participants = []

participants.each do |participant|
new_participant = participant.copy(val)
if new_participant
@copied_participants.push new_participant
end
end

return @copied_participants
end
</pre>
|}
=== Flash messages clustered under a single private method ===
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}
=== Fixed <code>email_sent</code> method ===
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}

= References=
<references/>

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T06:46:14Z

Pdeka:

'''E1560. Refactoring PopUpController.rb and ParticipantsController.rb'''

This page provides a description of the Expertiza based OSS project. This project is aimed at refactoring PopUpController.rb and ParticipantsController.rb.

=Introduction to Expertiza=
[http://http://expertiza.ncsu.edu/ Expertiza] is an [http://en.wikipedia.org/wiki/Open-source_software Open Source] [http://rubyonrails.org/ Rails] application which is used by instructors and students for creating assignments and submitting peer reviews. Expertiza allows the instructor to create and customize assignments, create a list of topics the students can sign up for, have students work on teams and then review each other's assignments at the end. The Source code of the application can be cloned from [https://github.com/expertiza/expertiza/ Github].

=Project Desicription<ref>https://docs.google.com/document/d/1uWs3zyrupTmrOFuv5IbVWCF4NRvCXqJmg8dZ0wCqgus/edit</ref>=
'''Files involved:'''
popUpController.rb
participantsController.rb

'''What they do'''
PopUpController displays a review when a user (instructor or student) clicks on a list of reviews.
ParticipantsController handles participants in an assignment.

'''What's wrong with them:'''
PopUpController contains only two prominent methods, but they are very big.
ParticipantsController contains redundant code.

'''What needs to be done:'''
'''1 popUpController.rb'''
1.1 Action_allowed method always returns true. It needs to be fixed.
1.2 Team_user_popup method needs refactoring. @teamId is assigned but never used. Add comments to make code more readable. Rename variables based on their usage
1.3 Refactor Participants_popup and team_users_popup methods into smaller private methods.


'''2 participantsController.rb'''
2.1 In add and update_authorization methods, permissions collection object can be used to reference its elements without assigning each element to individual private variables.
2.2 Inherit and bequeath_all methods are similar. Common statements can be migrated to private method. Add comments in code to make it easy to understand.
2.3 Cluster all the flash messages under one private method to make the code more manageable
2.4 Fix email_sent method. It contains a dummy email address.

=Changes Made<ref>https://github.com/viveksubbarao/expertiza/commits/master</ref>=

=='''PopUpController.rb'''==
===Modified <code>Action_allowed</code> method ===
Modified <code>Action_allowed</code> method to return true only if...
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def action_allowed?
true
end
</pre>
|<pre>
def action_allowed?
if @allowed_actions.include? params[:action]
true
else
false
end
end
</pre>
|}
===Refactored <code>Team_user_popup</code> method ===
Removed unused instance variable @teamId
Changed redundant instance variables to local variables
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def team_users_popup
@sum = 0
@count = 0
@teamid = params[:id]
@team = Team.find(params[:id])
@assignment = Assignment.find(@team.parent_id)
@assignment_id = @assignment.id
@id=params[:assignment_id]
# @teamname = Team.find(params[:id]).name
@teamusers = TeamsUser.where(team_id: params[:id])

#id2 seems to be a response_map
if(params[:id2] == nil)
# if(@reviewid == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id:params[:id2]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:id2]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: @reviewid)

questionnaire =Response.find(@reviewid).questionnaire_by_answer(@scores.first)
@maxscore = questionnaire.max_question_score

if(@maxscore == nil)
@maxscore = 5
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end

# @review_questionnaire = Questionnaire.find(@assignment.review_questionnaire_id)
# @review_questions = @review_questionnaire.questions
#@maxscore = @review_questionnaire.max_question_score

end
</pre>
|<pre>
def team_users_popup
@sum = 0
@team = Team.find(params[:id])
@id = params[:assignment_id]
@teamusers = TeamsUser.where(team_id: params[:id])

puts params
# response_map id can be used to index into the Response
# table and find the desired response.
if (params[:response_map_id] == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id: params[:response_map_id]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:response_map_id]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: response.id)
questionnaire = Response.find(@reviewid).questionnaire_by_answer(@scores.first)

if (questionnaire.max_question_score == nil)
@maxscore = 5 # This instance variable is needed. It's used in the team_users_popup view.
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end
end
</pre>
|}

===Refactored Participants_popup and team_users_popup methods into smaller private methods ===
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}



=='''ParticipantsController.rb'''==
===Permissions collection object referenced directly in <code>add</code> and <code>update_authorization methods</code>===
Local variables like can_submit, can_review, etc removed and permissions object referenced directly
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
curr_object.add_participant(params[:user][:name],can_submit,can_review,can_take_quiz)
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => can_submit, :can_review => can_review, :can_take_quiz => can_take_quiz)
......
end
</pre>
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
curr_object.add_participant(params[:user][:name], permissions[:can_submit],
permissions[:can_review], permissions[:can_take_quiz])
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => permissions[:can_submit],
:can_review => permissions[:can_review], :can_take_quiz => permissions[:can_take_quiz])
......
end
</pre>
|}
===Moved common functionality in <code>Inherit</code> and <code>bequeath_all</code> to private methods ===
Moved common functionality of <code>Inherit</code> and <code>bequeath_all</code> to private method <code>populate_copied_participants</code>
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def inherit
assignment = Assignment.find(params[:id])
course = assignment.course
@copied_participants = []

if course
participants = course.participants
if participants.length > 0
participants.each{|participant|
new_participant = participant.copy(params[:id])

if new_participant
@copied_participants.push new_participant
end
}

# Only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" has been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end

else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
@copied_participants = []
assignment = Assignment.find(params[:id])
if assignment.course
course = assignment.course
assignment.participants.each{ |participant|
new_participant = participant.copy(course.id)

if new_participant
@copied_participants.push new_participant
end
}
# only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". " )
else
flash[:note] = 'All assignment participants are already part of the course'
end

#flash[:note] = "All participants were successfully copied to \""+course.name+"\""
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end
</pre>
|<pre>
def inherit
assignment = Assignment.find(params[:id])

if assignment.course
if assignment.course.participants.length > 0
@copied_participants = populate_copied_participants(assignment.courses.participants, params[:id])
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" have been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end
else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
assignment = Assignment.find(params[:id])

if assignment.course
@copied_participants = populate_copied_participants(assignment.participants, assignment.course.id)
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". ")
else
flash[:note] = 'All assignment participants are already part of the course'
end
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def populate_copied_participants(participants, val)
@copied_participants = []

participants.each do |participant|
new_participant = participant.copy(val)
if new_participant
@copied_participants.push new_participant
end
end

return @copied_participants
end
</pre>
|}
===Flash messages clustered under a single private method ===
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}
===Fixed <code>email_sent</code> method ===
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}

= References=
<references/>

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T06:44:45Z

Pdeka:

'''E1560. Refactoring PopUpController.rb and ParticipantsController.rb'''

This page provides a description of the Expertiza based OSS project. This project is aimed at refactoring PopUpController.rb and ParticipantsController.rb.

=Introduction to Expertiza=
[http://http://expertiza.ncsu.edu/ Expertiza] is an [http://en.wikipedia.org/wiki/Open-source_software Open Source] [http://rubyonrails.org/ Rails] application which is used by instructors and students for creating assignments and submitting peer reviews. Expertiza allows the instructor to create and customize assignments, create a list of topics the students can sign up for, have students work on teams and then review each other's assignments at the end. The Source code of the application can be cloned from [https://github.com/expertiza/expertiza/ Github].

=Project Desicription<ref>https://docs.google.com/document/d/1uWs3zyrupTmrOFuv5IbVWCF4NRvCXqJmg8dZ0wCqgus/edit</ref>=
'''Files involved:'''
popUpController.rb
participantsController.rb

'''What they do'''
PopUpController displays a review when a user (instructor or student) clicks on a list of reviews.
ParticipantsController handles participants in an assignment.

'''What's wrong with them:'''
PopUpController contains only two prominent methods, but they are very big.
ParticipantsController contains redundant code.

'''What needs to be done:'''
'''1 popUpController.rb'''
1.1 Action_allowed method always returns true. It needs to be fixed.
1.2 Team_user_popup method needs refactoring. @teamId is assigned but never used. Add comments to make code more readable. Rename variables based on their usage
1.3 Refactor Participants_popup and team_users_popup methods into smaller private methods.


'''2 participantsController.rb'''
2.1 In add and update_authorization methods, permissions collection object can be used to reference its elements without assigning each element to individual private variables.
2.2 Inherit and bequeath_all methods are similar. Common statements can be migrated to private method. Add comments in code to make it easy to understand.
2.3 Cluster all the flash messages under one private method to make the code more manageable
2.4 Fix email_sent method. It contains a dummy email address.

=Changes Made<ref>https://github.com/viveksubbarao/expertiza/commits/master</ref>=

=='''PopUpController.rb'''==
===Case 1.1: Modified <code>Action_allowed</code> method ===
Modified <code>Action_allowed</code> method to return true only if...
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def action_allowed?
true
end
</pre>
|<pre>
def action_allowed?
if @allowed_actions.include? params[:action]
true
else
false
end
end
</pre>
|}
===Case 1.2: Refactored <code>Team_user_popup</code> method ===
Removed unused instance variable @teamId
Changed redundant instance variables to local variables
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def team_users_popup
@sum = 0
@count = 0
@teamid = params[:id]
@team = Team.find(params[:id])
@assignment = Assignment.find(@team.parent_id)
@assignment_id = @assignment.id
@id=params[:assignment_id]
# @teamname = Team.find(params[:id]).name
@teamusers = TeamsUser.where(team_id: params[:id])

#id2 seems to be a response_map
if(params[:id2] == nil)
# if(@reviewid == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id:params[:id2]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:id2]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: @reviewid)

questionnaire =Response.find(@reviewid).questionnaire_by_answer(@scores.first)
@maxscore = questionnaire.max_question_score

if(@maxscore == nil)
@maxscore = 5
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end

# @review_questionnaire = Questionnaire.find(@assignment.review_questionnaire_id)
# @review_questions = @review_questionnaire.questions
#@maxscore = @review_questionnaire.max_question_score

end
</pre>
|<pre>
def team_users_popup
@sum = 0
@team = Team.find(params[:id])
@id = params[:assignment_id]
@teamusers = TeamsUser.where(team_id: params[:id])

puts params
# response_map id can be used to index into the Response
# table and find the desired response.
if (params[:response_map_id] == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id: params[:response_map_id]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:response_map_id]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: response.id)
questionnaire = Response.find(@reviewid).questionnaire_by_answer(@scores.first)

if (questionnaire.max_question_score == nil)
@maxscore = 5 # This instance variable is needed. It's used in the team_users_popup view.
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end
end
</pre>
|}

===Case 1.3: Refactored Participants_popup and team_users_popup methods into smaller private methods ===
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}



=='''ParticipantsController.rb'''==
===Case 2.1: Permissions collection object referenced directly in <code>add</code> and <code>update_authorization methods</code>===
Local variables like can_submit, can_review, etc removed and permissions object referenced directly
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
curr_object.add_participant(params[:user][:name],can_submit,can_review,can_take_quiz)
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => can_submit, :can_review => can_review, :can_take_quiz => can_take_quiz)
......
end
</pre>
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
curr_object.add_participant(params[:user][:name], permissions[:can_submit],
permissions[:can_review], permissions[:can_take_quiz])
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => permissions[:can_submit],
:can_review => permissions[:can_review], :can_take_quiz => permissions[:can_take_quiz])
......
end
</pre>
|}
===Case 2.2: Moved common functionality in <code>Inherit</code> and <code>bequeath_all</code> to private methods ===
Moved common functionality of <code>Inherit</code> and <code>bequeath_all</code> to private method <code>populate_copied_participants</code>
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def inherit
assignment = Assignment.find(params[:id])
course = assignment.course
@copied_participants = []

if course
participants = course.participants
if participants.length > 0
participants.each{|participant|
new_participant = participant.copy(params[:id])

if new_participant
@copied_participants.push new_participant
end
}

# Only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" has been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end

else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
@copied_participants = []
assignment = Assignment.find(params[:id])
if assignment.course
course = assignment.course
assignment.participants.each{ |participant|
new_participant = participant.copy(course.id)

if new_participant
@copied_participants.push new_participant
end
}
# only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". " )
else
flash[:note] = 'All assignment participants are already part of the course'
end

#flash[:note] = "All participants were successfully copied to \""+course.name+"\""
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end
</pre>
|<pre>
def inherit
assignment = Assignment.find(params[:id])

if assignment.course
if assignment.course.participants.length > 0
@copied_participants = populate_copied_participants(assignment.courses.participants, params[:id])
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" have been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end
else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
assignment = Assignment.find(params[:id])

if assignment.course
@copied_participants = populate_copied_participants(assignment.participants, assignment.course.id)
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". ")
else
flash[:note] = 'All assignment participants are already part of the course'
end
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def populate_copied_participants(participants, val)
@copied_participants = []

participants.each do |participant|
new_participant = participant.copy(val)
if new_participant
@copied_participants.push new_participant
end
end

return @copied_participants
end
</pre>
|}
===Case 2.3: Flash messages clustered under a single private method ===
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}
===Case 2.4: Fixed <code>email_sent</code> method ===
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}

= References=
<references/>

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T06:38:30Z

Pdeka:

'''E1560. Refactoring PopUpController.rb and ParticipantsController.rb'''

This page provides a description of the Expertiza based OSS project. This project is aimed at refactoring PopUpController.rb and ParticipantsController.rb.

=Introduction to Expertiza=
[http://http://expertiza.ncsu.edu/ Expertiza] is an [http://en.wikipedia.org/wiki/Open-source_software Open Source] [http://rubyonrails.org/ Rails] application which is used by instructors and students for creating assignments and submitting peer reviews. Expertiza allows the instructor to create and customize assignments, create a list of topics the students can sign up for, have students work on teams and then review each other's assignments at the end. The Source code of the application can be cloned from [https://github.com/expertiza/expertiza/ Github].

=Project Desicription<ref>https://docs.google.com/document/d/1uWs3zyrupTmrOFuv5IbVWCF4NRvCXqJmg8dZ0wCqgus/edit</ref>=
'''Files involved:'''
popUpController.rb
participantsController.rb

'''What they do'''
PopUpController displays a review when a user (instructor or student) clicks on a list of reviews.
ParticipantsController handles participants in an assignment.

'''What's wrong with them:'''
PopUpController contains only two prominent methods, but they are very big.
ParticipantsController contains redundant code.

'''What needs to be done:'''
'''1 popUpController.rb'''
1.1 Action_allowed method always returns true. It needs to be fixed.
1.2 Team_user_popup method needs refactoring. @teamId is assigned but never used. Add comments to make code more readable. Rename variables based on their usage
1.3 Refactor Participants_popup and team_users_popup methods into smaller private methods.


'''2 participantsController.rb'''
2.1 In add and update_authorization methods, permissions collection object can be used to reference its elements without assigning each element to individual private variables.
2.2 Inherit and bequeath_all methods are similar. Common statements can be migrated to private method. Add comments in code to make it easy to understand.
2.3 Cluster all the flash messages under one private method to make the code more manageable
2.4 Fix email_sent method. It contains a dummy email address.

=Changes Made<ref>https://github.com/viveksubbarao/expertiza/commits/master</ref>=

'''PopUpController.rb'''
==Case 1.1: Modified <code>Action_allowed</code> method ==
Modified <code>Action_allowed</code> method to return true only if...
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def action_allowed?
true
end
</pre>
|<pre>
def action_allowed?
if @allowed_actions.include? params[:action]
true
else
false
end
end
</pre>
|}
==Case 1.2: Refactored <code>Team_user_popup</code> method ==
Removed unused instance variable @teamId
Changed redundant instance variables to local variables
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def team_users_popup
@sum = 0
@count = 0
@teamid = params[:id]
@team = Team.find(params[:id])
@assignment = Assignment.find(@team.parent_id)
@assignment_id = @assignment.id
@id=params[:assignment_id]
# @teamname = Team.find(params[:id]).name
@teamusers = TeamsUser.where(team_id: params[:id])

#id2 seems to be a response_map
if(params[:id2] == nil)
# if(@reviewid == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id:params[:id2]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:id2]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: @reviewid)

questionnaire =Response.find(@reviewid).questionnaire_by_answer(@scores.first)
@maxscore = questionnaire.max_question_score

if(@maxscore == nil)
@maxscore = 5
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end

# @review_questionnaire = Questionnaire.find(@assignment.review_questionnaire_id)
# @review_questions = @review_questionnaire.questions
#@maxscore = @review_questionnaire.max_question_score

end
</pre>
|<pre>
def team_users_popup
@sum = 0
@team = Team.find(params[:id])
@id = params[:assignment_id]
@teamusers = TeamsUser.where(team_id: params[:id])

puts params
# response_map id can be used to index into the Response
# table and find the desired response.
if (params[:response_map_id] == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id: params[:response_map_id]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:response_map_id]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: response.id)
questionnaire = Response.find(@reviewid).questionnaire_by_answer(@scores.first)

if (questionnaire.max_question_score == nil)
@maxscore = 5 # This instance variable is needed. It's used in the team_users_popup view.
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end
end
</pre>
|}

==Case 1.3: Refactored Participants_popup and team_users_popup methods into smaller private methods ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}



'''ParticipantsController.rb'''
==Case 2.1: Permissions collection object referenced directly in <code>add</code> and <code>update_authorization methods</code>==
Local variables like can_submit, can_review, etc removed and permissions object referenced directly
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
curr_object.add_participant(params[:user][:name],can_submit,can_review,can_take_quiz)
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => can_submit, :can_review => can_review, :can_take_quiz => can_take_quiz)
......
end
</pre>
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
curr_object.add_participant(params[:user][:name], permissions[:can_submit],
permissions[:can_review], permissions[:can_take_quiz])
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => permissions[:can_submit],
:can_review => permissions[:can_review], :can_take_quiz => permissions[:can_take_quiz])
......
end
</pre>
|}
==Case 2.2: Moved common functionality in <code>Inherit</code> and <code>bequeath_all</code> to private methods ==
Moved common functionality of <code>Inherit</code> and <code>bequeath_all</code> to private method <code>populate_copied_participants</code>
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def inherit
assignment = Assignment.find(params[:id])
course = assignment.course
@copied_participants = []

if course
participants = course.participants
if participants.length > 0
participants.each{|participant|
new_participant = participant.copy(params[:id])

if new_participant
@copied_participants.push new_participant
end
}

# Only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" has been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end

else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
@copied_participants = []
assignment = Assignment.find(params[:id])
if assignment.course
course = assignment.course
assignment.participants.each{ |participant|
new_participant = participant.copy(course.id)

if new_participant
@copied_participants.push new_participant
end
}
# only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". " )
else
flash[:note] = 'All assignment participants are already part of the course'
end

#flash[:note] = "All participants were successfully copied to \""+course.name+"\""
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end
</pre>
|<pre>
def inherit
assignment = Assignment.find(params[:id])

if assignment.course
if assignment.course.participants.length > 0
@copied_participants = populate_copied_participants(assignment.courses.participants, params[:id])
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" have been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end
else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
assignment = Assignment.find(params[:id])

if assignment.course
@copied_participants = populate_copied_participants(assignment.participants, assignment.course.id)
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". ")
else
flash[:note] = 'All assignment participants are already part of the course'
end
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def populate_copied_participants(participants, val)
@copied_participants = []

participants.each do |participant|
new_participant = participant.copy(val)
if new_participant
@copied_participants.push new_participant
end
end

return @copied_participants
end
</pre>
|}
==Case 2.3: Flash messages clustered under a single private method ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}
==Case 2.4: Fixed <code>email_sent</code> method ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}

= References=
<references/>

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T06:34:48Z

Pdeka:

'''E1560. Refactoring PopUpController.rb and ParticipantsController.rb'''

This page provides a description of the Expertiza based OSS project. This project is aimed at refactoring PopUpController.rb and ParticipantsController.rb.

=Introduction to Expertiza=
[http://http://expertiza.ncsu.edu/ Expertiza] is an [http://en.wikipedia.org/wiki/Open-source_software Open Source] [http://rubyonrails.org/ Rails] application which is used by instructors and students for creating assignments and submitting peer reviews. Expertiza allows the instructor to create and customize assignments, create a list of topics the students can sign up for, have students work on teams and then review each other's assignments at the end. The Source code of the application can be cloned from [https://github.com/expertiza/expertiza/ Github].

=Project Desicription<ref>https://docs.google.com/document/d/1uWs3zyrupTmrOFuv5IbVWCF4NRvCXqJmg8dZ0wCqgus/edit</ref>=
'''Files involved:'''
popUpController.rb
participantsController.rb

'''What they do'''
PopUpController displays a review when a user (instructor or student) clicks on a list of reviews.
ParticipantsController handles participants in an assignment.

'''What's wrong with them:'''
PopUpController contains only two prominent methods, but they are very big.
ParticipantsController contains redundant code.

'''What needs to be done:'''
'''1 popUpController.rb'''
1.1 Action_allowed method always returns true. It needs to be fixed.
1.2 Team_user_popup method needs refactoring. @teamId is assigned but never used. Add comments to make code more readable. Rename variables based on their usage
1.3 Refactor Participants_popup and team_users_popup methods into smaller private methods.


'''2 participantsController.rb'''
2.1 In add and update_authorization methods, permissions collection object can be used to reference its elements without assigning each element to individual private variables.
2.2 Inherit and bequeath_all methods are similar. Common statements can be migrated to private method. Add comments in code to make it easy to understand.
2.3 Cluster all the flash messages under one private method to make the code more manageable
2.4 Fix email_sent method. It contains a dummy email address.

=Changes Made<ref>https://github.com/viveksubbarao/expertiza/commits/master</ref>=

'''PopUpController.rb'''
==Case 1.1: Modified <code>Action_allowed</code> method ==
Modified <code>Action_allowed</code> method to return true only if...
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def action_allowed?
true
end
</pre>
|<pre>
def action_allowed?
if @allowed_actions.include? params[:action]
true
else
false
end
end
</pre>
|}
==Case 1.2: Refactored <code>Team_user_popup</code> method ==
Removed unused instance variable @teamId
Changed redundant instance variables to local variables
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def team_users_popup
@sum = 0
@count = 0
@teamid = params[:id]
@team = Team.find(params[:id])
@assignment = Assignment.find(@team.parent_id)
@assignment_id = @assignment.id
@id=params[:assignment_id]
# @teamname = Team.find(params[:id]).name
@teamusers = TeamsUser.where(team_id: params[:id])

#id2 seems to be a response_map
if(params[:id2] == nil)
# if(@reviewid == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id:params[:id2]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:id2]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: @reviewid)

questionnaire =Response.find(@reviewid).questionnaire_by_answer(@scores.first)
@maxscore = questionnaire.max_question_score

if(@maxscore == nil)
@maxscore = 5
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end

# @review_questionnaire = Questionnaire.find(@assignment.review_questionnaire_id)
# @review_questions = @review_questionnaire.questions
#@maxscore = @review_questionnaire.max_question_score

end
</pre>
|<pre>
def team_users_popup
@sum = 0
@team = Team.find(params[:id])
@id = params[:assignment_id]
@teamusers = TeamsUser.where(team_id: params[:id])

puts params
# response_map id can be used to index into the Response
# table and find the desired response.
if (params[:response_map_id] == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id: params[:response_map_id]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:response_map_id]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: response.id)
questionnaire = Response.find(@reviewid).questionnaire_by_answer(@scores.first)

if (questionnaire.max_question_score == nil)
@maxscore = 5 # This instance variable is needed. It's used in the team_users_popup view.
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end
end
</pre>
|}

==Case 1.3: Refactored Participants_popup and team_users_popup methods into smaller private methods ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}



'''ParticipantsController.rb'''
==Case 2.1: Permissions collection object referenced directly in <code>add</code> and <code>update_authorization methods</code>==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
curr_object.add_participant(params[:user][:name],can_submit,can_review,can_take_quiz)
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => can_submit, :can_review => can_review, :can_take_quiz => can_take_quiz)
......
end
</pre>
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
curr_object.add_participant(params[:user][:name], permissions[:can_submit],
permissions[:can_review], permissions[:can_take_quiz])
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => permissions[:can_submit],
:can_review => permissions[:can_review], :can_take_quiz => permissions[:can_take_quiz])
......
end
</pre>
|}
==Case 2.2: Moved common functionality in <code>Inherit</code> and <code>bequeath_all</code> to private methods ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def inherit
assignment = Assignment.find(params[:id])
course = assignment.course
@copied_participants = []

if course
participants = course.participants
if participants.length > 0
participants.each{|participant|
new_participant = participant.copy(params[:id])

if new_participant
@copied_participants.push new_participant
end
}

# Only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" has been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end

else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
@copied_participants = []
assignment = Assignment.find(params[:id])
if assignment.course
course = assignment.course
assignment.participants.each{ |participant|
new_participant = participant.copy(course.id)

if new_participant
@copied_participants.push new_participant
end
}
# only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". " )
else
flash[:note] = 'All assignment participants are already part of the course'
end

#flash[:note] = "All participants were successfully copied to \""+course.name+"\""
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end
</pre>
|<pre>
def inherit
assignment = Assignment.find(params[:id])

if assignment.course
if assignment.course.participants.length > 0
@copied_participants = populate_copied_participants(assignment.courses.participants, params[:id])
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" have been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end
else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
assignment = Assignment.find(params[:id])

if assignment.course
@copied_participants = populate_copied_participants(assignment.participants, assignment.course.id)
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". ")
else
flash[:note] = 'All assignment participants are already part of the course'
end
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def populate_copied_participants(participants, val)
@copied_participants = []

participants.each do |participant|
new_participant = participant.copy(val)
if new_participant
@copied_participants.push new_participant
end
end

return @copied_participants
end
</pre>
|}
==Case 2.3: Flash messages clustered under a single private method ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}
==Case 2.4: Fixed <code>email_sent</code> method ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}

= References=
<references/>

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T06:26:28Z

Pdeka:

'''E1560. Refactoring PopUpController.rb and ParticipantsController.rb'''

This page provides a description of the Expertiza based OSS project. This project is aimed at refactoring PopUpController.rb and ParticipantsController.rb.

=Introduction to Expertiza=
[http://http://expertiza.ncsu.edu/ Expertiza] is an [http://en.wikipedia.org/wiki/Open-source_software Open Source] [http://rubyonrails.org/ Rails] application which is used by instructors and students for creating assignments and submitting peer reviews. Expertiza allows the instructor to create and customize assignments, create a list of topics the students can sign up for, have students work on teams and then review each other's assignments at the end. The Source code of the application can be cloned from [https://github.com/expertiza/expertiza/ Github].

=Project Desicription<ref>https://docs.google.com/document/d/1uWs3zyrupTmrOFuv5IbVWCF4NRvCXqJmg8dZ0wCqgus/edit</ref>=
'''Files involved:'''
popUpController.rb
participantsController.rb

'''What they do'''
PopUpController displays a review when a user (instructor or student) clicks on a list of reviews.
ParticipantsController handles participants in an assignment.

'''What's wrong with them:'''
PopUpController contains only two prominent methods, but they are very big.
ParticipantsController contains redundant code.

'''What needs to be done:'''
'''1 popUpController.rb'''
1.1 Action_allowed method always returns true. It needs to be fixed.
1.2 Team_user_popup method needs refactoring. @teamId is assigned but never used. Add comments to make code more readable. Rename variables based on their usage
1.3 Instance variables need to be changed to local variable wherever possible.
1.4 Refactor Participants_popup and team_users_popup methods into smaller private methods.


'''2 participantsController.rb'''
2.1 In add and update_authorization methods, permissions collection object can be used to reference its elements without assigning each element to individual private variables.
2.2 Inherit and bequeath_all methods are similar. Common statements can be migrated to private method. Add comments in code to make it easy to understand.
2.3 Cluster all the flash messages under one private method to make the code more manageable
2.4 Fix email_sent method. It contains a dummy email address.

=Changes Made<ref>https://github.com/viveksubbarao/expertiza/commits/master</ref>=

'''PopUpController.rb'''
==Case 1.1: Modified <code>Action_allowed</code> method to return true only if .. ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def action_allowed?
true
end
</pre>
|<pre>
def action_allowed?
if @allowed_actions.include? params[:action]
true
else
false
end
end
</pre>
|}
==Case 1.2: Refactored <code>Team_user_popup</code> method ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def team_users_popup
@sum = 0
@count = 0
@teamid = params[:id]
@team = Team.find(params[:id])
@assignment = Assignment.find(@team.parent_id)
@assignment_id = @assignment.id
@id=params[:assignment_id]
# @teamname = Team.find(params[:id]).name
@teamusers = TeamsUser.where(team_id: params[:id])

#id2 seems to be a response_map
if(params[:id2] == nil)
# if(@reviewid == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id:params[:id2]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:id2]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: @reviewid)

questionnaire =Response.find(@reviewid).questionnaire_by_answer(@scores.first)
@maxscore = questionnaire.max_question_score

if(@maxscore == nil)
@maxscore = 5
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end

# @review_questionnaire = Questionnaire.find(@assignment.review_questionnaire_id)
# @review_questions = @review_questionnaire.questions
#@maxscore = @review_questionnaire.max_question_score

end
</pre>
|<pre>
def team_users_popup
@sum = 0
@team = Team.find(params[:id])
@id = params[:assignment_id]
@teamusers = TeamsUser.where(team_id: params[:id])

puts params
# response_map id can be used to index into the Response
# table and find the desired response.
if (params[:response_map_id] == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id: params[:response_map_id]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:response_map_id]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: response.id)
questionnaire = Response.find(@reviewid).questionnaire_by_answer(@scores.first)

if (questionnaire.max_question_score == nil)
@maxscore = 5 # This instance variable is needed. It's used in the team_users_popup view.
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end
end
</pre>
|}
==Case 1.3: Redundant instance variables changed to local variables ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}
==Case 1.4: Refactored Participants_popup and team_users_popup methods into smaller private methods ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}



'''ParticipantsController.rb'''
==Case 2.1: Permissions collection object referenced directly in <code>add</code> and <code>update_authorization methods</code>==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
curr_object.add_participant(params[:user][:name],can_submit,can_review,can_take_quiz)
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => can_submit, :can_review => can_review, :can_take_quiz => can_take_quiz)
......
end
</pre>
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
curr_object.add_participant(params[:user][:name], permissions[:can_submit],
permissions[:can_review], permissions[:can_take_quiz])
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => permissions[:can_submit],
:can_review => permissions[:can_review], :can_take_quiz => permissions[:can_take_quiz])
......
end
</pre>
|}
==Case 2.2: Moved common functionality in <code>Inherit</code> and <code>bequeath_all</code> to private methods ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def inherit
assignment = Assignment.find(params[:id])
course = assignment.course
@copied_participants = []

if course
participants = course.participants
if participants.length > 0
participants.each{|participant|
new_participant = participant.copy(params[:id])

if new_participant
@copied_participants.push new_participant
end
}

# Only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" has been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end

else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
@copied_participants = []
assignment = Assignment.find(params[:id])
if assignment.course
course = assignment.course
assignment.participants.each{ |participant|
new_participant = participant.copy(course.id)

if new_participant
@copied_participants.push new_participant
end
}
# only display undo link if copies of participants are created
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". " )
else
flash[:note] = 'All assignment participants are already part of the course'
end

#flash[:note] = "All participants were successfully copied to \""+course.name+"\""
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end
</pre>
|<pre>
def inherit
assignment = Assignment.find(params[:id])

if assignment.course
if assignment.course.participants.length > 0
@copied_participants = populate_copied_participants(assignment.courses.participants, params[:id])
if @copied_participants.length > 0
undo_link("Participants from \"#{course.name}\" have been copied to this assignment successfully. ")
else
flash[:note] = 'All course participants are already in this assignment'
end
else
flash[:note] = "No participants were found to inherit."
end
else
flash[:error] = "No course was found for this assignment."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def bequeath_all
assignment = Assignment.find(params[:id])

if assignment.course
@copied_participants = populate_copied_participants(assignment.participants, assignment.course.id)
if @copied_participants.length > 0
undo_link("All participants were successfully copied to \"#{course.name}\". ")
else
flash[:note] = 'All assignment participants are already part of the course'
end
else
flash[:error] = "This assignment is not associated with a course."
end

redirect_to :controller => 'participants', :action => 'list', :id => assignment.id, :model => 'Assignment'
end

def populate_copied_participants(participants, val)
@copied_participants = []

participants.each do |participant|
new_participant = participant.copy(val)
if new_participant
@copied_participants.push new_participant
end
end

return @copied_participants
end
</pre>
|}
==Case 2.3: Flash messages clustered under a single private method ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}
==Case 2.4: Fixed <code>email_sent</code> method ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}

= References=
<references/>

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T06:20:20Z

Pdeka:

'''E1560. Refactoring PopUpController.rb and ParticipantsController.rb'''

This page provides a description of the Expertiza based OSS project. This project is aimed at refactoring PopUpController.rb and ParticipantsController.rb.

=Introduction to Expertiza=
[http://http://expertiza.ncsu.edu/ Expertiza] is an [http://en.wikipedia.org/wiki/Open-source_software Open Source] [http://rubyonrails.org/ Rails] application which is used by instructors and students for creating assignments and submitting peer reviews. Expertiza allows the instructor to create and customize assignments, create a list of topics the students can sign up for, have students work on teams and then review each other's assignments at the end. The Source code of the application can be cloned from [https://github.com/expertiza/expertiza/ Github].

=Project Desicription<ref>https://docs.google.com/document/d/1uWs3zyrupTmrOFuv5IbVWCF4NRvCXqJmg8dZ0wCqgus/edit</ref>=
'''Files involved:'''
popUpController.rb
participantsController.rb

'''What they do'''
PopUpController displays a review when a user (instructor or student) clicks on a list of reviews.
ParticipantsController handles participants in an assignment.

'''What's wrong with them:'''
PopUpController contains only two prominent methods, but they are very big.
ParticipantsController contains redundant code.

'''What needs to be done:'''
'''1 popUpController.rb'''
1.1 Action_allowed method always returns true. It needs to be fixed.
1.2 Team_user_popup method needs refactoring. @teamId is assigned but never used. Add comments to make code more readable. Rename variables based on their usage
1.3 Instance variables need to be changed to local variable wherever possible.
1.4 Refactor Participants_popup and team_users_popup methods into smaller private methods.


'''2 participantsController.rb'''
2.1 In add and update_authorization methods, permissions collection object can be used to reference its elements without assigning each element to individual private variables.
2.2 Inherit and bequeath_all methods are similar. Common statements can be migrated to private method. Add comments in code to make it easy to understand.
2.3 Cluster all the flash messages under one private method to make the code more manageable
2.4 Fix email_sent method. It contains a dummy email address.

=Changes Made<ref>https://github.com/viveksubbarao/expertiza/commits/master</ref>=

'''PopUpController.rb'''
==Case 1.1: Modified <code>Action_allowed</code> method to return true only if .. ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def action_allowed?
true
end
</pre>
|<pre>
def action_allowed?
if @allowed_actions.include? params[:action]
true
else
false
end
end
</pre>
|}
==Case 1.2: Refactored <code>Team_user_popup</code> method ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def team_users_popup
@sum = 0
@count = 0
@teamid = params[:id]
@team = Team.find(params[:id])
@assignment = Assignment.find(@team.parent_id)
@assignment_id = @assignment.id
@id=params[:assignment_id]
# @teamname = Team.find(params[:id]).name
@teamusers = TeamsUser.where(team_id: params[:id])

#id2 seems to be a response_map
if(params[:id2] == nil)
# if(@reviewid == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id:params[:id2]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:id2]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: @reviewid)

questionnaire =Response.find(@reviewid).questionnaire_by_answer(@scores.first)
@maxscore = questionnaire.max_question_score

if(@maxscore == nil)
@maxscore = 5
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end

# @review_questionnaire = Questionnaire.find(@assignment.review_questionnaire_id)
# @review_questions = @review_questionnaire.questions
#@maxscore = @review_questionnaire.max_question_score

end
</pre>
|<pre>
def team_users_popup
@sum = 0
@team = Team.find(params[:id])
@id = params[:assignment_id]
@teamusers = TeamsUser.where(team_id: params[:id])

puts params
# response_map id can be used to index into the Response
# table and find the desired response.
if (params[:response_map_id] == nil)
@scores = nil
else
#get the last response from response_map id
response = Response.where(map_id: params[:response_map_id]).last
@reviewid = response.id
@pid = ResponseMap.find(params[:response_map_id]).reviewer_id
@reviewer_id = Participant.find(@pid).user_id

@scores = Answer.where(response_id: response.id)
questionnaire = Response.find(@reviewid).questionnaire_by_answer(@scores.first)

if (questionnaire.max_question_score == nil)
@maxscore = 5 # This instance variable is needed. It's used in the team_users_popup view.
end

@total_percentage = response.get_average_score
@sum = response.get_total_score
@total_possible = response.get_maximum_score
end
end
</pre>
|}
==Case 1.3: Redundant instance variables changed to local variables ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}
==Case 1.4: Refactored Participants_popup and team_users_popup methods into smaller private methods ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}



'''ParticipantsController.rb'''
==Case 2.1: Permissions collection object referenced directly in <code>add</code> and <code>update_authorization methods</code>==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
curr_object.add_participant(params[:user][:name],can_submit,can_review,can_take_quiz)
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
can_submit = permissions[:can_submit]
can_review = permissions[:can_review]
can_take_quiz = permissions[:can_take_quiz]
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => can_submit, :can_review => can_review, :can_take_quiz => can_take_quiz)
......
end
</pre>
|<pre>
def add
......
permissions = Participant.get_permissions(params[:authorization])
curr_object.add_participant(params[:user][:name], permissions[:can_submit],
permissions[:can_review], permissions[:can_take_quiz])
......
end

def update_authorizations
......
permissions = Participant.get_permissions(params[:authorization])
participant = Participant.find(params[:id])
parent_id = participant.parent_id
participant.update_attributes(:can_submit => permissions[:can_submit],
:can_review => permissions[:can_review], :can_take_quiz => permissions[:can_take_quiz])
......
end
</pre>
|}
==Case 2.2: Moved common functionality in <code>Inherit</code> and <code>bequeath_all</code> to private methods ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}
==Case 2.3: Flash messages clustered under a single private method ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}
==Case 2.4: Fixed <code>email_sent</code> method ==
{| class="wikitable"
|-
! |Before Refactoring
! |After Refactoring
|- style="vertical-align:top;"
|<pre>

</pre>
|<pre>

</pre>
|}

= References=
<references/>

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T06:14:31Z

Pdeka:

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T06:11:56Z

Pdeka:

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T06:07:58Z

Pdeka:

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T06:04:37Z

Pdeka:

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T05:22:07Z

Pdeka:

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T05:17:55Z

Pdeka:

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T05:16:30Z

Pdeka:

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T04:57:24Z

Pdeka:

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T04:50:23Z

Pdeka:

CSC/ECE 517 Fall 2015/oss E1560 PSV

2015-10-31T04:34:52Z

Pdeka: Created page with "'''E1560. Refactoring PopUpController.rb and ParticipantsController.rb''' This page provides a description of the Expertiza based OSS project. This project is aimed at refactori..."

CSC/ECE 517 Fall 2015

2015-10-31T04:18:09Z

Pdeka:

==Writing Assignment 2==
*[[CSC/ECE_517_Fall_2015/sample_page]]
*[[CSC/ECE_517_Fall_2015/ossE1558BGJ]]
*[[CSC/ECE 517 Fall 2015/oss/M1502/AAAASS]]
*[[CSC/ECE 517 Fall 2015/oss/M1503/IntegrateXMLParser]]
*[[CSC/ECE_517_Fall_2015/ossE1568BZHXJS]]
*[[CSC/ECE_517_Fall_2015/ossE1572VGA]]
*[[CSC/ECE_517_Fall_2015/oss_E1573_sap]]
*[[CSC/ECE 517 Fall 2015/oss E1559 rrz]]
*[[CSC/ECE 517 Fall 2015/oss E1570 avr]]
*[[CSC/ECE 517 Fall 2015/oss E1556 CHM]]
*[[CSC/ECE 517 Fall 2015/oss M1504 JJD]]
*[[CSC/ECE 517 Fall 2015/oss E1562 APS]]
*[[CSC/ECE 517 Fall 2015/oss M1501 GSN]]
*[[CSC/ECE 517 Fall 2015/oss M1501 GSN]]
*[[CSC/ECE 517 Fall 2015/oss E1551 RGS]]
*[[CSC/ECE 517 Fall 2015/oss E1555 GMR]]
*[[CSC/ECE 517 Fall 2015/oss E1552 NRR]]
*[[CSC/ECE 517 Fall 2015/oss E1565 AAJ]]
*[[CSC/ECE 517 Fall 2015/oss E1561 WZL]]
*[[CSC/ECE 517 Fall 2015/oss E1553 AAJ]]
*[[CSC/ECE 517 Fall 2015/oss E1554 AAR]]
*[[CSC/ECE 517 Fall 2015/oss E1569 JNR]]
*[[CSC/ECE 517 Fall 2015/oss E1560 PSV]]