Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T17:27:22Z

Jgu7: /* Files Involved */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case to underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| '''Refactor Getter and Setter Accessor'''
|
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

*views/grades/_participant.html.erb

*views/grades/_scores_author_feedback.html.erb

*views/grades/_scores_metareview.html.erb

*views/grades/_scores_submitted_work.html.erb

*views/grades/_tabbing.html.erb

*views/grades/edit.html.erb

*views/response/_review.html.erb

*views/response/_submitted_files.html.erb

*views/response/view.html.erb
|-
| '''Reduce Local Variables In Views'''
|
*views/grades/_scores_author_feedback.html.erb
*views/grades/_participant.html.erb
*views/grades/_scores_header.html.erb
*views/grades/_submitted_work.html.erb

|-
| '''Calculations Found in Views'''
|
*views/grades/_participant.html.erb
*views/grades/_scores_author_feedback.html.erb

|}

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using encapsulation to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to encapsulate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*After confirmation with Professor and TAs, we no longer need to check the existence of the topic.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===

We find that there are some calculations in the views('''_participant.html.erb'''). The main function of these calculations in the _participant.html.erb is to curve the teams' total score. It gets the value of total_score from the instance variable('''@pscore''') and computes them in the views.

The whole project utilizes the MVC design pattern to achieve a clean separation among three components(Model-View-Controller). However, the above calculations violate the MVC design pattern and ruin the program's structure. Meanwhile, it will increase the workload of the views and decrease performance of the website.

In order to implement the MVC design pattern much better and improve the performance of the website, we move these calculations to the model to avoid these problems. In current system, the participant's total score is obtained by calling the '''participant.scores''' method in gradesController, so we move these calculations into scores method which is declared in the model of '''assignment_participant.rb'''.

By testing, our solution solves the above problem effectively. Meanwhile, we adopt single responsibility principle and DRY principle to simplify our code.

===Encapsulation===

In the '''grade/_participant.html.erb''' file, there are plenty of local variables such as min, max and avg. When we need to return the grades of a student for different type of reviews, we need to create different variables. This not only ruins the readability of the code, but also tends to cause problem for future maintenance and development. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in this file, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those information directly from '''Rscore'''.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code look cleaner.

Furthermore, '''pscore''' is a complicated data structure. It consists of huge hash tables, with each hash table contains another hash table as its value. This situation makes polymorphism pretty hard to implement,if we are not allowed to modify the data structure of the score, which is the basic structure of the system.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[https://docs.google.com/document/d/1ncwlrTEZ1taP6ZvMc_GqP4jcAchE03zXSnZwvzgfeDw/edit?usp=sharing ''Requirement for E147'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

[http://youtu.be/RPfzaGtJtQc ''Youtube Demo'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T17:25:16Z

Jgu7: /* Files Involved */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case to underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| '''Refactor Getter and Setter Accessor'''
|
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

*views/grades/_participant.html.erb

*views/grades/_scores_author_feedback.html.erb

*views/grades/_scores_metareview.html.erb

*views/grades/_scores_submitted_work.html.erb

*views/grades/_tabbing.html.erb

*views/grades/edit.html.erb

*views/response/_review.html.erb

*views/response/_submitted_files.html.erb

*views/response/view.html.erb
|-
| '''Reduce Local Variables In Views'''
|
*views/grades/_scores_author_feedback.html.erb
*views/grades/_participant.html.erb
*views/grades/_scores_header.html.erb
*views/grades/_submitted_work.html.erb

|-
| '''Calculations Found in Views''':
|
*views/grades/_participant.html.erb
*views/grades/_scores_author_feedback.html.erb

|}

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using encapsulation to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to encapsulate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*After confirmation with Professor and TAs, we no longer need to check the existence of the topic.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===

We find that there are some calculations in the views('''_participant.html.erb'''). The main function of these calculations in the _participant.html.erb is to curve the teams' total score. It gets the value of total_score from the instance variable('''@pscore''') and computes them in the views.

The whole project utilizes the MVC design pattern to achieve a clean separation among three components(Model-View-Controller). However, the above calculations violate the MVC design pattern and ruin the program's structure. Meanwhile, it will increase the workload of the views and decrease performance of the website.

In order to implement the MVC design pattern much better and improve the performance of the website, we move these calculations to the model to avoid these problems. In current system, the participant's total score is obtained by calling the '''participant.scores''' method in gradesController, so we move these calculations into scores method which is declared in the model of '''assignment_participant.rb'''.

By testing, our solution solves the above problem effectively. Meanwhile, we adopt single responsibility principle and DRY principle to simplify our code.

===Encapsulation===

In the '''grade/_participant.html.erb''' file, there are plenty of local variables such as min, max and avg. When we need to return the grades of a student for different type of reviews, we need to create different variables. This not only ruins the readability of the code, but also tends to cause problem for future maintenance and development. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in this file, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those information directly from '''Rscore'''.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code look cleaner.

Furthermore, '''pscore''' is a complicated data structure. It consists of huge hash tables, with each hash table contains another hash table as its value. This situation makes polymorphism pretty hard to implement,if we are not allowed to modify the data structure of the score, which is the basic structure of the system.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[https://docs.google.com/document/d/1ncwlrTEZ1taP6ZvMc_GqP4jcAchE03zXSnZwvzgfeDw/edit?usp=sharing ''Requirement for E147'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

[http://youtu.be/RPfzaGtJtQc ''Youtube Demo'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T17:25:00Z

Jgu7: /* Files Involved */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case to underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| '''Refactor Getter and Setter Accessor'''
|*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

*views/grades/_participant.html.erb

*views/grades/_scores_author_feedback.html.erb

*views/grades/_scores_metareview.html.erb

*views/grades/_scores_submitted_work.html.erb

*views/grades/_tabbing.html.erb

*views/grades/edit.html.erb

*views/response/_review.html.erb

*views/response/_submitted_files.html.erb

*views/response/view.html.erb
|-
| '''Reduce Local Variables In Views'''
|
*views/grades/_scores_author_feedback.html.erb
*views/grades/_participant.html.erb
*views/grades/_scores_header.html.erb
*views/grades/_submitted_work.html.erb

|-
| '''Calculations Found in Views''':
|
*views/grades/_participant.html.erb
*views/grades/_scores_author_feedback.html.erb

|}

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using encapsulation to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to encapsulate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*After confirmation with Professor and TAs, we no longer need to check the existence of the topic.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===

We find that there are some calculations in the views('''_participant.html.erb'''). The main function of these calculations in the _participant.html.erb is to curve the teams' total score. It gets the value of total_score from the instance variable('''@pscore''') and computes them in the views.

The whole project utilizes the MVC design pattern to achieve a clean separation among three components(Model-View-Controller). However, the above calculations violate the MVC design pattern and ruin the program's structure. Meanwhile, it will increase the workload of the views and decrease performance of the website.

In order to implement the MVC design pattern much better and improve the performance of the website, we move these calculations to the model to avoid these problems. In current system, the participant's total score is obtained by calling the '''participant.scores''' method in gradesController, so we move these calculations into scores method which is declared in the model of '''assignment_participant.rb'''.

By testing, our solution solves the above problem effectively. Meanwhile, we adopt single responsibility principle and DRY principle to simplify our code.

===Encapsulation===

In the '''grade/_participant.html.erb''' file, there are plenty of local variables such as min, max and avg. When we need to return the grades of a student for different type of reviews, we need to create different variables. This not only ruins the readability of the code, but also tends to cause problem for future maintenance and development. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in this file, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those information directly from '''Rscore'''.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code look cleaner.

Furthermore, '''pscore''' is a complicated data structure. It consists of huge hash tables, with each hash table contains another hash table as its value. This situation makes polymorphism pretty hard to implement,if we are not allowed to modify the data structure of the score, which is the basic structure of the system.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[https://docs.google.com/document/d/1ncwlrTEZ1taP6ZvMc_GqP4jcAchE03zXSnZwvzgfeDw/edit?usp=sharing ''Requirement for E147'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

[http://youtu.be/RPfzaGtJtQc ''Youtube Demo'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T17:18:49Z

Jgu7: /* Files Involved */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case to underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| '''Refactor Getter and Setter Accessor'''
|*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

*views/grades/_participant.html.erb

*views/grades/_scores_author_feedback.html.erb

*views/grades/_scores_metareview.html.erb

*views/grades/_scores_submitted_work.html.erb

*views/grades/_tabbing.html.erb

*views/grades/edit.html.erb

*views/response/_review.html.erb

*views/response/_submitted_files.html.erb

*views/response/view.html.erb
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}
'''Refactor Getter and Setter Accessor''':

*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

*views/grades/_participant.html.erb

*views/grades/_scores_author_feedback.html.erb

*views/grades/_scores_metareview.html.erb

*views/grades/_scores_submitted_work.html.erb

*views/grades/_tabbing.html.erb

*views/grades/edit.html.erb

*views/response/_review.html.erb

*views/response/_submitted_files.html.erb

*views/response/view.html.erb

'''Reduce Local Variables In Views''':
*views/grades/_scores_author_feedback.html.erb
*views/grades/_participant.html.erb
*views/grades/_scores_header.html.erb
*views/grades/_submitted_work.html.erb
'''Calculations Found in Views''':
*views/grades/_participant.html.erb
*views/grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using encapsulation to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to encapsulate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*After confirmation with Professor and TAs, we no longer need to check the existence of the topic.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===

We find that there are some calculations in the views('''_participant.html.erb'''). The main function of these calculations in the _participant.html.erb is to curve the teams' total score. It gets the value of total_score from the instance variable('''@pscore''') and computes them in the views.

The whole project utilizes the MVC design pattern to achieve a clean separation among three components(Model-View-Controller). However, the above calculations violate the MVC design pattern and ruin the program's structure. Meanwhile, it will increase the workload of the views and decrease performance of the website.

In order to implement the MVC design pattern much better and improve the performance of the website, we move these calculations to the model to avoid these problems. In current system, the participant's total score is obtained by calling the '''participant.scores''' method in gradesController, so we move these calculations into scores method which is declared in the model of '''assignment_participant.rb'''.

By testing, our solution solves the above problem effectively. Meanwhile, we adopt single responsibility principle and DRY principle to simplify our code.

===Encapsulation===

In the '''grade/_participant.html.erb''' file, there are plenty of local variables such as min, max and avg. When we need to return the grades of a student for different type of reviews, we need to create different variables. This not only ruins the readability of the code, but also tends to cause problem for future maintenance and development. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in this file, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those information directly from '''Rscore'''.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code look cleaner.

Furthermore, '''pscore''' is a complicated data structure. It consists of huge hash tables, with each hash table contains another hash table as its value. This situation makes polymorphism pretty hard to implement,if we are not allowed to modify the data structure of the score, which is the basic structure of the system.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[https://docs.google.com/document/d/1ncwlrTEZ1taP6ZvMc_GqP4jcAchE03zXSnZwvzgfeDw/edit?usp=sharing ''Requirement for E147'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

[http://youtu.be/RPfzaGtJtQc ''Youtube Demo'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T17:17:14Z

Jgu7: /* Files Involved */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case to underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| '''Refactor Getter and Setter Accessor'''
| *models/participant.rb
|*models/rscore.rb
|*models/assignment_participant.rb
|*models/assignment.rb
|*models/assignment_participant.rb

|*models/assignment_team.rb

|*models/course.rb

|*models/course_participant.rb

|*models/course_team.rb

|*controllers/grades_controller.rb

|*controllers/scores_controller.rb

|*controllers/assignments_controller.rb

|*controllers/assignment_controller.rb

|*views/grades/_participant.html.erb

|*views/grades/_scores_author_feedback.html.erb

|*views/grades/_scores_metareview.html.erb

|*views/grades/_scores_submitted_work.html.erb

|*views/grades/_tabbing.html.erb

|*views/grades/edit.html.erb

|*views/response/_review.html.erb

|*views/response/_submitted_files.html.erb

|*views/response/view.html.erb
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}
'''Refactor Getter and Setter Accessor''':

*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

*views/grades/_participant.html.erb

*views/grades/_scores_author_feedback.html.erb

*views/grades/_scores_metareview.html.erb

*views/grades/_scores_submitted_work.html.erb

*views/grades/_tabbing.html.erb

*views/grades/edit.html.erb

*views/response/_review.html.erb

*views/response/_submitted_files.html.erb

*views/response/view.html.erb

'''Reduce Local Variables In Views''':
*views/grades/_scores_author_feedback.html.erb
*views/grades/_participant.html.erb
*views/grades/_scores_header.html.erb
*views/grades/_submitted_work.html.erb
'''Calculations Found in Views''':
*views/grades/_participant.html.erb
*views/grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using encapsulation to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to encapsulate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*After confirmation with Professor and TAs, we no longer need to check the existence of the topic.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===

We find that there are some calculations in the views('''_participant.html.erb'''). The main function of these calculations in the _participant.html.erb is to curve the teams' total score. It gets the value of total_score from the instance variable('''@pscore''') and computes them in the views.

The whole project utilizes the MVC design pattern to achieve a clean separation among three components(Model-View-Controller). However, the above calculations violate the MVC design pattern and ruin the program's structure. Meanwhile, it will increase the workload of the views and decrease performance of the website.

In order to implement the MVC design pattern much better and improve the performance of the website, we move these calculations to the model to avoid these problems. In current system, the participant's total score is obtained by calling the '''participant.scores''' method in gradesController, so we move these calculations into scores method which is declared in the model of '''assignment_participant.rb'''.

By testing, our solution solves the above problem effectively. Meanwhile, we adopt single responsibility principle and DRY principle to simplify our code.

===Encapsulation===

In the '''grade/_participant.html.erb''' file, there are plenty of local variables such as min, max and avg. When we need to return the grades of a student for different type of reviews, we need to create different variables. This not only ruins the readability of the code, but also tends to cause problem for future maintenance and development. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in this file, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those information directly from '''Rscore'''.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code look cleaner.

Furthermore, '''pscore''' is a complicated data structure. It consists of huge hash tables, with each hash table contains another hash table as its value. This situation makes polymorphism pretty hard to implement,if we are not allowed to modify the data structure of the score, which is the basic structure of the system.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[https://docs.google.com/document/d/1ncwlrTEZ1taP6ZvMc_GqP4jcAchE03zXSnZwvzgfeDw/edit?usp=sharing ''Requirement for E147'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

[http://youtu.be/RPfzaGtJtQc ''Youtube Demo'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T17:13:56Z

Jgu7: /* Files Involved */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case to underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===

'''Refactor Getter and Setter Accessor''':

*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

*views/grades/_participant.html.erb

*views/grades/_scores_author_feedback.html.erb

*views/grades/_scores_metareview.html.erb

*views/grades/_scores_submitted_work.html.erb

*views/grades/_tabbing.html.erb

*views/grades/edit.html.erb

*views/response/_review.html.erb

*views/response/_submitted_files.html.erb

*views/response/view.html.erb

'''Reduce Local Variables In Views''':
*views/grades/_scores_author_feedback.html.erb
*views/grades/_participant.html.erb
*views/grades/_scores_header.html.erb
*views/grades/_submitted_work.html.erb
'''Calculations Found in Views''':
*views/grades/_participant.html.erb
*views/grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using encapsulation to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to encapsulate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*After confirmation with Professor and TAs, we no longer need to check the existence of the topic.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===

We find that there are some calculations in the views('''_participant.html.erb'''). The main function of these calculations in the _participant.html.erb is to curve the teams' total score. It gets the value of total_score from the instance variable('''@pscore''') and computes them in the views.

The whole project utilizes the MVC design pattern to achieve a clean separation among three components(Model-View-Controller). However, the above calculations violate the MVC design pattern and ruin the program's structure. Meanwhile, it will increase the workload of the views and decrease performance of the website.

In order to implement the MVC design pattern much better and improve the performance of the website, we move these calculations to the model to avoid these problems. In current system, the participant's total score is obtained by calling the '''participant.scores''' method in gradesController, so we move these calculations into scores method which is declared in the model of '''assignment_participant.rb'''.

By testing, our solution solves the above problem effectively. Meanwhile, we adopt single responsibility principle and DRY principle to simplify our code.

===Encapsulation===

In the '''grade/_participant.html.erb''' file, there are plenty of local variables such as min, max and avg. When we need to return the grades of a student for different type of reviews, we need to create different variables. This not only ruins the readability of the code, but also tends to cause problem for future maintenance and development. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in this file, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those information directly from '''Rscore'''.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code look cleaner.

Furthermore, '''pscore''' is a complicated data structure. It consists of huge hash tables, with each hash table contains another hash table as its value. This situation makes polymorphism pretty hard to implement,if we are not allowed to modify the data structure of the score, which is the basic structure of the system.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[https://docs.google.com/document/d/1ncwlrTEZ1taP6ZvMc_GqP4jcAchE03zXSnZwvzgfeDw/edit?usp=sharing ''Requirement for E147'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

[http://youtu.be/RPfzaGtJtQc ''Youtube Demo'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T17:08:27Z

Jgu7: /* Files Involved */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case to underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===

'''Refactor Getter and Setter Accessor''':

*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

*views/grades/_participant.html.erb

*views/grades/_scores_author_feedback.html.erb

*views/grades/_scores_metareview.html.erb

*views/grades/_scores_submitted_work.html.erb

*views/grades/_tabbing.html.erb

*views/grades/edit.html.erb

*views/response/_review.html.erb

*views/response/_submitted_files.html.erb

*views/response/view.html.erb

'''Reduce Local Variables In Views''':
*views/grades/_participant.html.erb
'''Calculations Found in Views''':
*views/grades/_participant.html.erb
*views/grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using encapsulation to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to encapsulate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*After confirmation with Professor and TAs, we no longer need to check the existence of the topic.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===

We find that there are some calculations in the views('''_participant.html.erb'''). The main function of these calculations in the _participant.html.erb is to curve the teams' total score. It gets the value of total_score from the instance variable('''@pscore''') and computes them in the views.

The whole project utilizes the MVC design pattern to achieve a clean separation among three components(Model-View-Controller). However, the above calculations violate the MVC design pattern and ruin the program's structure. Meanwhile, it will increase the workload of the views and decrease performance of the website.

In order to implement the MVC design pattern much better and improve the performance of the website, we move these calculations to the model to avoid these problems. In current system, the participant's total score is obtained by calling the '''participant.scores''' method in gradesController, so we move these calculations into scores method which is declared in the model of '''assignment_participant.rb'''.

By testing, our solution solves the above problem effectively. Meanwhile, we adopt single responsibility principle and DRY principle to simplify our code.

===Encapsulation===

In the '''grade/_participant.html.erb''' file, there are plenty of local variables such as min, max and avg. When we need to return the grades of a student for different type of reviews, we need to create different variables. This not only ruins the readability of the code, but also tends to cause problem for future maintenance and development. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in this file, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those information directly from '''Rscore'''.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code look cleaner.

Furthermore, '''pscore''' is a complicated data structure. It consists of huge hash tables, with each hash table contains another hash table as its value. This situation makes polymorphism pretty hard to implement,if we are not allowed to modify the data structure of the score, which is the basic structure of the system.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[https://docs.google.com/document/d/1ncwlrTEZ1taP6ZvMc_GqP4jcAchE03zXSnZwvzgfeDw/edit?usp=sharing ''Requirement for E147'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

[http://youtu.be/RPfzaGtJtQc ''Youtube Demo'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T17:07:55Z

Jgu7: /* Files Involved */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case to underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===

'''Refactor Getter and Setter Accessor''':

*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

*views/grades/_participant.html.erb

*views/grades/_scores_author_feedback.html.erb

*views/grades/_scores_metareview.html.erb

*views/grades/_scores_submitted_work.html.erb

*views/grades/_tabbing.html.erb

*views/grades/edit.html.erb

*views/response/_review.html.erb

*views/response/_submitted_files.html.erb

*views/response/view.html.erb

'''Reduce Local Variables In Views''':

'''Calculations Found in Views''':
*views/grades/_participant.html.erb
*views/grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using encapsulation to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to encapsulate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*After confirmation with Professor and TAs, we no longer need to check the existence of the topic.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===

We find that there are some calculations in the views('''_participant.html.erb'''). The main function of these calculations in the _participant.html.erb is to curve the teams' total score. It gets the value of total_score from the instance variable('''@pscore''') and computes them in the views.

The whole project utilizes the MVC design pattern to achieve a clean separation among three components(Model-View-Controller). However, the above calculations violate the MVC design pattern and ruin the program's structure. Meanwhile, it will increase the workload of the views and decrease performance of the website.

In order to implement the MVC design pattern much better and improve the performance of the website, we move these calculations to the model to avoid these problems. In current system, the participant's total score is obtained by calling the '''participant.scores''' method in gradesController, so we move these calculations into scores method which is declared in the model of '''assignment_participant.rb'''.

By testing, our solution solves the above problem effectively. Meanwhile, we adopt single responsibility principle and DRY principle to simplify our code.

===Encapsulation===

In the '''grade/_participant.html.erb''' file, there are plenty of local variables such as min, max and avg. When we need to return the grades of a student for different type of reviews, we need to create different variables. This not only ruins the readability of the code, but also tends to cause problem for future maintenance and development. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in this file, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those information directly from '''Rscore'''.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code look cleaner.

Furthermore, '''pscore''' is a complicated data structure. It consists of huge hash tables, with each hash table contains another hash table as its value. This situation makes polymorphism pretty hard to implement,if we are not allowed to modify the data structure of the score, which is the basic structure of the system.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[https://docs.google.com/document/d/1ncwlrTEZ1taP6ZvMc_GqP4jcAchE03zXSnZwvzgfeDw/edit?usp=sharing ''Requirement for E147'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

[http://youtu.be/RPfzaGtJtQc ''Youtube Demo'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T17:05:48Z

Jgu7: /* Files Involved */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case to underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===

'''Refactor Getter and Setter Accessor''':

*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

*views/grades/_participant.html.erb

*views/grades/_scores_author_feedback.html.erb

*views/grades/_scores_metareview.html.erb

*views/grades/_scores_submitted_work.html.erb

*views/grades/_tabbing.html.erb

*views/grades/edit.html.erb

*views/response/_review.html.erb

*views/response/_submitted_files.html.erb

*views/response/view.html.erb

'''Calculations Found in Views''':
*views/grades/_participant.html.erb
*views/grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using encapsulation to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to encapsulate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*After confirmation with Professor and TAs, we no longer need to check the existence of the topic.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===

We find that there are some calculations in the views('''_participant.html.erb'''). The main function of these calculations in the _participant.html.erb is to curve the teams' total score. It gets the value of total_score from the instance variable('''@pscore''') and computes them in the views.

The whole project utilizes the MVC design pattern to achieve a clean separation among three components(Model-View-Controller). However, the above calculations violate the MVC design pattern and ruin the program's structure. Meanwhile, it will increase the workload of the views and decrease performance of the website.

In order to implement the MVC design pattern much better and improve the performance of the website, we move these calculations to the model to avoid these problems. In current system, the participant's total score is obtained by calling the '''participant.scores''' method in gradesController, so we move these calculations into scores method which is declared in the model of '''assignment_participant.rb'''.

By testing, our solution solves the above problem effectively. Meanwhile, we adopt single responsibility principle and DRY principle to simplify our code.

===Encapsulation===

In the '''grade/_participant.html.erb''' file, there are plenty of local variables such as min, max and avg. When we need to return the grades of a student for different type of reviews, we need to create different variables. This not only ruins the readability of the code, but also tends to cause problem for future maintenance and development. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in this file, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those information directly from '''Rscore'''.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code look cleaner.

Furthermore, '''pscore''' is a complicated data structure. It consists of huge hash tables, with each hash table contains another hash table as its value. This situation makes polymorphism pretty hard to implement,if we are not allowed to modify the data structure of the score, which is the basic structure of the system.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[https://docs.google.com/document/d/1ncwlrTEZ1taP6ZvMc_GqP4jcAchE03zXSnZwvzgfeDw/edit?usp=sharing ''Requirement for E147'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

[http://youtu.be/RPfzaGtJtQc ''Youtube Demo'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T17:04:19Z

Jgu7: /* Files Involved */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case to underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===

'''Refactor Getter and Setter Accessor''':
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using encapsulation to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to encapsulate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*After confirmation with Professor and TAs, we no longer need to check the existence of the topic.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===

We find that there are some calculations in the views('''_participant.html.erb'''). The main function of these calculations in the _participant.html.erb is to curve the teams' total score. It gets the value of total_score from the instance variable('''@pscore''') and computes them in the views.

The whole project utilizes the MVC design pattern to achieve a clean separation among three components(Model-View-Controller). However, the above calculations violate the MVC design pattern and ruin the program's structure. Meanwhile, it will increase the workload of the views and decrease performance of the website.

In order to implement the MVC design pattern much better and improve the performance of the website, we move these calculations to the model to avoid these problems. In current system, the participant's total score is obtained by calling the '''participant.scores''' method in gradesController, so we move these calculations into scores method which is declared in the model of '''assignment_participant.rb'''.

By testing, our solution solves the above problem effectively. Meanwhile, we adopt single responsibility principle and DRY principle to simplify our code.

===Encapsulation===

In the '''grade/_participant.html.erb''' file, there are plenty of local variables such as min, max and avg. When we need to return the grades of a student for different type of reviews, we need to create different variables. This not only ruins the readability of the code, but also tends to cause problem for future maintenance and development. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in this file, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those information directly from '''Rscore'''.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code look cleaner.

Furthermore, '''pscore''' is a complicated data structure. It consists of huge hash tables, with each hash table contains another hash table as its value. This situation makes polymorphism pretty hard to implement,if we are not allowed to modify the data structure of the score, which is the basic structure of the system.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[https://docs.google.com/document/d/1ncwlrTEZ1taP6ZvMc_GqP4jcAchE03zXSnZwvzgfeDw/edit?usp=sharing ''Requirement for E147'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

[http://youtu.be/RPfzaGtJtQc ''Youtube Demo'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T17:03:44Z

Jgu7: /* Files Involved */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case to underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===

'''Refactor Getter and Setter Accessor'''
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using encapsulation to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to encapsulate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*After confirmation with Professor and TAs, we no longer need to check the existence of the topic.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===

We find that there are some calculations in the views('''_participant.html.erb'''). The main function of these calculations in the _participant.html.erb is to curve the teams' total score. It gets the value of total_score from the instance variable('''@pscore''') and computes them in the views.

The whole project utilizes the MVC design pattern to achieve a clean separation among three components(Model-View-Controller). However, the above calculations violate the MVC design pattern and ruin the program's structure. Meanwhile, it will increase the workload of the views and decrease performance of the website.

In order to implement the MVC design pattern much better and improve the performance of the website, we move these calculations to the model to avoid these problems. In current system, the participant's total score is obtained by calling the '''participant.scores''' method in gradesController, so we move these calculations into scores method which is declared in the model of '''assignment_participant.rb'''.

By testing, our solution solves the above problem effectively. Meanwhile, we adopt single responsibility principle and DRY principle to simplify our code.

===Encapsulation===

In the '''grade/_participant.html.erb''' file, there are plenty of local variables such as min, max and avg. When we need to return the grades of a student for different type of reviews, we need to create different variables. This not only ruins the readability of the code, but also tends to cause problem for future maintenance and development. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in this file, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those information directly from '''Rscore'''.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code look cleaner.

Furthermore, '''pscore''' is a complicated data structure. It consists of huge hash tables, with each hash table contains another hash table as its value. This situation makes polymorphism pretty hard to implement,if we are not allowed to modify the data structure of the score, which is the basic structure of the system.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[https://docs.google.com/document/d/1ncwlrTEZ1taP6ZvMc_GqP4jcAchE03zXSnZwvzgfeDw/edit?usp=sharing ''Requirement for E147'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

[http://youtu.be/RPfzaGtJtQc ''Youtube Demo'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T02:52:43Z

Jgu7: /* The function of the calculation */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using inheritance to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to delegate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===
====Why move calculation from view to model====
First, MVC-Model-View-Controller - is a design pattern for the architecture of web applications. It is a widely adopted pattern, across many languages and implementation frameworks, whose purpose is to achieve a clean separation between three components of most any web application.

Second, more calculation in the view will decrease the speed and performance of the website.

====The function of the calculation====
In the file of _participant.html.erb show all team's score. Before that, the view gets the total score from @pscore, and curves the total score in the view.
The calculation is in the /views/grades/_participant.html.erb. The main function is to curve the total score. We move these calculation into the method of /model/assignment_participant.rb.

why use mvc
calculation's function
why put them in the model

===OOP===

===Encapsulation===

In the original code, there are plenty of local variables such as min, max and avg. This not only ruins the readability of the code, but also tends to cause problem for future development. Since min, max and avg are the mostly used variables, we created a new data structure Rscore, which encapsulate all these three variables. Whenever we need the value of min, max and avg, we can get those from Rscore.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code looks cleaner.

What is more, pscore is a complicated data structure. It is a huge hash table, which contains at least two more level of hash tables in it. This situation makes polymorphism pretty hard to implement, since we can't do it without changing some basic structure of the design.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T02:46:46Z

Jgu7: /* The function of the calculation */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using inheritance to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to delegate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===
====Why move calculation from view to model====
First, MVC-Model-View-Controller - is a design pattern for the architecture of web applications. It is a widely adopted pattern, across many languages and implementation frameworks, whose purpose is to achieve a clean separation between three components of most any web application.

Second, more calculation in the view will decrease the speed and performance of the website.

====The function of the calculation====
The view of _participant.html.erb show all team's score. Before that, the view gets the total score from @pscore, and curves the total score in the view.
The calculation is in the /views/grades/_participant.html.erb. The main function is to curve the total score. We move these calculation into the method of /model/assignment_participant.rb.

why use mvc
calculation's function
why put them in the model

===OOP===

===Encapsulation===

In the original code, there are plenty of local variables such as min, max and avg. This not only ruins the readability of the code, but also tends to cause problem for future development. Since min, max and avg are the mostly used variables, we created a new data structure Rscore, which encapsulate all these three variables. Whenever we need the value of min, max and avg, we can get those from Rscore.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code looks cleaner.

What is more, pscore is a complicated data structure. It is a huge hash table, which contains at least two more level of hash tables in it. This situation makes polymorphism pretty hard to implement, since we can't do it without changing some basic structure of the design.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T02:37:09Z

Jgu7: /* Why move calculation from view to model */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using inheritance to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to delegate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===
====Why move calculation from view to model====
First, MVC-Model-View-Controller - is a design pattern for the architecture of web applications. It is a widely adopted pattern, across many languages and implementation frameworks, whose purpose is to achieve a clean separation between three components of most any web application.

Second, more calculation in the view will decrease the speed and performance of the website.

====The function of the calculation====
The calculation is in the /views/grades/_participant.html.erb. The main function is to curve the total score. We move these calculation into the method of /model/assignment_participant.rb.

why use mvc
calculation's function
why put them in the model

===OOP===

===Encapsulation===

In the original code, there are plenty of local variables such as min, max and avg. This not only ruins the readability of the code, but also tends to cause problem for future development. Since min, max and avg are the mostly used variables, we created a new data structure Rscore, which encapsulate all these three variables. Whenever we need the value of min, max and avg, we can get those from Rscore.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code looks cleaner.

What is more, pscore is a complicated data structure. It is a huge hash table, which contains at least two more level of hash tables in it. This situation makes polymorphism pretty hard to implement, since we can't do it without changing some basic structure of the design.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T02:31:38Z

Jgu7: /* The function of the calculation */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using inheritance to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to delegate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===
====Why move calculation from view to model====
First, MVC-Model-View-Controller - is a design pattern for the architecture of web applications. It is a widely adopted pattern, across many languages and implementation frameworks, whose purpose is to achieve a clean separation between three components of most any web application.

Second, more calculation in the view will decrease the speed and performance of client terminal.

====The function of the calculation====
The calculation is in the /views/grades/_participant.html.erb. The main function is to curve the total score. We move these calculation into the method of /model/assignment_participant.rb.

why use mvc
calculation's function
why put them in the model

===OOP===

===Encapsulation===

In the original code, there are plenty of local variables such as min, max and avg. This not only ruins the readability of the code, but also tends to cause problem for future development. Since min, max and avg are the mostly used variables, we created a new data structure Rscore, which encapsulate all these three variables. Whenever we need the value of min, max and avg, we can get those from Rscore.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code looks cleaner.

What is more, pscore is a complicated data structure. It is a huge hash table, which contains at least two more level of hash tables in it. This situation makes polymorphism pretty hard to implement, since we can't do it without changing some basic structure of the design.

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T02:24:06Z

Jgu7: /* The function of the calculation */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using inheritance to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to delegate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===
====Why move calculation from view to model====
First, MVC-Model-View-Controller - is a design pattern for the architecture of web applications. It is a widely adopted pattern, across many languages and implementation frameworks, whose purpose is to achieve a clean separation between three components of most any web application.

Second, more calculation in the view will decrease the speed and performance of client terminal.

====The function of the calculation====
The calculation is in the /views/grades/_participant.html.erb. The main function is to curve the total score.

why use mvc
calculation's function
why put them in the model

===OOP===

===Encapsulation===

In the original code, there are plenty of local variables such as min, max and avg. This not only ruins the readability of the code, but also tends to cause problem for future development. Since min, max and avg are the mostly used variables, we created a new data structure Rscore, which put all these three variables together.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code looks cleaner.
What is more, pscore is a complicated data structure, it is a huge hash table, which contains at least two more hash tables in it.
This situation makes polymorphism not only hard to implement, but also

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T02:16:43Z

Jgu7: /* Why move calculation from view to model */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using inheritance to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to delegate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===
====Why move calculation from view to model====
First, MVC-Model-View-Controller - is a design pattern for the architecture of web applications. It is a widely adopted pattern, across many languages and implementation frameworks, whose purpose is to achieve a clean separation between three components of most any web application.

Second, more calculation in the view will decrease the speed and performance of client terminal.

====The function of the calculation====

why use mvc
calculation's function
why put them in the model

===Encapsulation===
Set up a new data structure, Rscore, and use this data structure to delegate score in all the views.

In the original code, there are plenty of local variables such as min, max and avg. This not only ruins the readability of the code, but also tends to cause problem for future development. Since min, max and avg are the mostly used variables, we created a new data structure Rscore, which put all these three variables together.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code looks cleaner.
What is more, pscore is a complicated data structure, it is a huge hash table, which contains at least two more hash tables in it.
This situation makes polymorphism not only hard to implement, but also

===OOP===

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T02:06:20Z

Jgu7: /* Why move calculation from view to model */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.189:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using inheritance to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to delegate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===
====Why move calculation from view to model====
First, MVC-Model-View-Controller - is a design pattern for the architecture of web applications. It is a widely adopted pattern, across many languages and implementation frameworks, whose purpose is to achieve a clean separation between three components of most any web application.
Second, more calculation in the view will decrease the speed and performance of client terminal.
====The function of the calculation====

why use mvc
calculation's function
why put them in the model

===OOP===

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Encapsulation===
Set up a new data structure, Rscore, and use this data structure to delegate score in all the views.

In the original code, there are plenty of local variables such as min, max and avg. This not only ruins the readability of the code, but also tends to cause problem for future development. Since min, max and avg are the mostly used variables, we created a new data structure Rscore, which put all these three variables together.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code looks cleaner.
What is more, pscore is a complicated data structure, it is a huge hash table, which contains at least two more hash tables in it.
This situation makes polymorphism not only hard to implement, but also

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T02:04:06Z

Jgu7: /* Log in to MySql */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.
==Set Up Environment==

===User Guide===
Current System (After Refactoring Grades_controller):

http://152.46.18.10:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

Original System (Before Refactoring Grades_controller):

http://152.1.13.97:3000/

Instructor: user6 Password: test

Student: user1600 and user1601 Password: test

All our test result based on the following test cases on expertiza, please follow these step to get it.

Instructor: (Searching "Program 2" using "Ctrl + F" will be convinient for you.)

Steps: Login -> Assignments->Program 2 style ->view scores.

Student:

Steps: Login -> Assignments->Program 2 style ->Your scores.

===Set Up Environment Locally===
====Get Expertiza from Github====
<pre style="white-space:normal;">git clone https://github.com/maxlpy/expertiza.git</pre>
====Use rvm to install ruby-2.1.0====
<pre style="white-space:normal;">curl -L https://get.rvm.io | bash -s stable</pre>
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>
<pre style="white-space:normal;">echo "source ~/.rvm/scripts/rvm" >> ~/.bashrc</pre>
<pre style="white-space:normal;">rvm install 2.1.0</pre>
<pre style="white-space:normal;">rvm use 2.1.0 --default</pre>
<pre style="white-space:normal;">ruby -v</pre>

====Install Bundled Gems====
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

====Set Up the Database====
=====Enable and Start the MySql Daemon=====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
=====Set the MySql Root Password=====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
=====Log in to MySql=====
<pre style="white-space:normal;">mysql -uroot -p</pre>

====Create the Databases====
<pre style="white-space:normal;">rake db:create:all</pre>
====Build the Expertiza Database====
<pre style="white-space:normal;">rake db:migrate</pre>
====Start Expertiza service====
<pre style="white-space:normal;">rails server</pre>

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using inheritance to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to delegate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===
====Why move calculation from view to model====
First, MVC-Model-View-Controller - is a design pattern for the architecture of web applications. It is a widely adopted pattern, across many languages and implementation frameworks, whose purpose is to achieve a clean separation between three components of most any web application.
Second, more calculation in the view will decrease the speed and performance of client terminal.

why use mvc
calculation's function
why put them in the model

===OOP===

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Encapsulation===
Set up a new data structure, Rscore, and use this data structure to delegate score in all the views.

In the original code, there are plenty of local variables such as min, max and avg. This not only ruins the readability of the code, but also tends to cause problem for future development. Since min, max and avg are the mostly used variables, we created a new data structure Rscore, which put all these three variables together.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code looks cleaner.
What is more, pscore is a complicated data structure, it is a huge hash table, which contains at least two more hash tables in it.
This situation makes polymorphism not only hard to implement, but also

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T02:03:55Z

Jgu7: /* Why move calculation from view to model */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using inheritance to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to delegate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, encapsulation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===
====Why move calculation from view to model====
First, MVC-Model-View-Controller - is a design pattern for the architecture of web applications. It is a widely adopted pattern, across many languages and implementation frameworks, whose purpose is to achieve a clean separation between three components of most any web application.
Second, more calculation in the view will decrease the speed and performance of client terminal.

why use mvc
calculation's function
why put them in the model

===OOP===

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Encapsulation===
Set up a new data structure, Rscore, and use this data structure to delegate score in all the views.

In the original code, there are plenty of local variables such as min, max and avg. This not only ruins the readability of the code, but also tends to cause problem for future development. Since min, max and avg are the mostly used variables, we created a new data structure Rscore, which put all these three variables together.

In the project specification, it suggested that we use polymorphism to reduce the redundant local variables. However, we found that this simple data structure will suffice without bothering to use polymorphism, and it makes the code looks cleaner.
What is more, pscore is a complicated data structure, it is a huge hash table, which contains at least two more hash tables in it.
This situation makes polymorphism not only hard to implement, but also

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T02:00:57Z

Jgu7: /* Moving calculation from view to model */

==Design Document==
'''E1472: Connect changes to score model with changes to score views'''

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.

== Requirements ==

===A way to query db models to return scores, without UI changes===

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

===UI changes for reporting scores===

The grades_controller class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn't have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

===Files Involved===
'''Model''':
*models/participant.rb

*models/rscore.rb

*models/assignment_participant.rb

*models/assignment.rb

*models/assignment_participant.rb

*models/assignment_team.rb

*models/course.rb

*models/course_participant.rb

*models/course_team.rb

'''Controller''':
*controllers/grades_controller.rb

*controllers/scores_controller.rb

*controllers/assignments_controller.rb

*controllers/assignment_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

*grades/_tabbing.html.erb

*grades/edit.html.erb

*response/_review.html.erb

*response/_submitted_files.html.erb

*response/view.html.erb

'''Calculations Found in Views''':
*grades/_participant.html.erb
*grades/_scores_author_feedback.html.erb

===What we are going to do===

*Modify the setters and getters in the models/participant.rb by refactoring

*Modify the camel-case variables to underscores to match the Ruby convention in views/grades/... , models/participant.rb and controllers/grades_controller.rb

*Modify the data structure of the score, instead of using pScore which contains lots of hash tables in it, we set up a new object, '''Rscore''', which only consists of max, min and average fields of each reviews. Also, using inheritance to implement this data structure to avoid check review type.

*delete checking for topics in views

*Move the calculations in the views to the model so that there won't be many calculations in the views of MVC framework.(Model file:'''assignment_participant.rb''')

===What we have done===

*We modified the camel-case variables in views/grade to Ruby convention by replacing them with under_score format while keeping the camel-case in JavaScript, as in JavaScript the camel-case should be its convention.

*We set up new data structure Rscore to delegate the score and reduce the local variables.

*We analysed the system and found out that polymorphism for Rscore is not necessary, delegation will handle all the usages.

*We moved the calculations in the views into model file,'''assignment_participants.rb''', which follows the single responsibility principle and DRY principle.

*We modified the response_map to expedite the rendering speed of showing scores.

==Details of Implementation==
===Moving calculation from view to model===
====Why move calculation from view to model====
First, MVC-Model-View-Controller - is a design pattern for the architecture of web applications. It is a widely adopted pattern, across many languages and implementation frameworks, whose purpose is to achieve a clean separation between three components of most any web application.
Second,

why use mvc
calculation's function
why put them in the model

===OOP===

==Design Pattern and System Architecture==

[[File:Expertiza003.png‎|frame|center|]]

===MVC design pattern===
Responsibility of view_my_scores html.erb is to display all the scores with respect to a participant and an assignment. For achieving optimal functionality, a good amount of refactoring had to be done in the views that were responsible for displaying the results to a user.(By removing all the calculations in the views to models)

Apart from the template methods that are present in other controller class, the grades_controller specifically has two more important methods: view and view_my_scores.

*'''view method''': handle the functionality of viewing the assignments of the whole class. Understandably, this is done through an admin/instructor's profile as only they have the privilege of viewing all participants' scores.

*'''view_my_scores''': take care of displaying the scores pertaining to an assignment to a single user.

Scores.rb has two methods which are responsible to compute scores for the participants based on assignments and courses.

*'''get_total_scores()''' method: make multiple sequential queries to the database to calculate scores.

*Model class PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

===DRY Principle===
This ensures that information is not repeated in the application. We use DRY Principle to design our object and modify all other work.(By setting up Rscore data structure)

===Delegation===
Set up a new data structure, Rscore, and use this data structure to delegate score in all the views.
In pscore,
2. delegation
3. why not polymorphism. simple data structure can work out.
4 pscore is a complicated data structure, it is a huge hash table.

===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.(By setting up Rscore data structure)

== Use Case==

[[File:Use_case_2.png|frame|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 100%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).
|-
| Admin
| This actor has the same responsibility as Instructor along with the ability to create instructor(however, this is not our concern here).
|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

The following table is showing the use case of different users of the expertiza and how they interact with it. For example, when a student want to view his/her grades, there must be something in the database (precondition). He will need to login, and choose one of the assignments which he want to view grade on. He can also see the review of his work.

{| class="wikitable"
|-
! Name !! Actor !! Other Participants || Precondition || Primary Sequence
|-
| Student views his team score || Student || None || At least team's score exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| TA views teams' review || TA || None||At least team's review exists. ||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page
|-
| Instructor/ Teaching Assistant/ Admin views the list of teams scores || Instructor/ Teaching Assistant/ Admin || None || At least one team's score exists.||
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu
|}

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:Objected Oriented Design.png|frame|center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

===Create object to avoid local variables===
Create rscore class in models (rscore.rb):
<pre>
class Rscore
attr_accessor :my_max,:my_min,:my_avg,:my_type

def initialize(my_score,type)
@my_max=my_score[type][:scores][:max]
@my_min=my_score[type][:scores][:min]
@my_avg=my_score[type][:scores][:avg]
@my_type=type
end
end
</pre>

===Use instance variables in views===
In grades/_participant.html.erb, we create an object that has max, min, and avg fields for each kind of reviews, and pass the kind of review when referring to a max, min, or avg field.

'''Before:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
s_max = pscore[:review][:scores][:max]
s_min = pscore[:review][:scores][:min]
s_avg = pscore[:review][:scores][:avg]
end
if pscore[:metareview]
r_max = pscore[:metareview][:scores][:max]
r_min = pscore[:metareview][:scores][:min]
r_avg = pscore[:metareview][:scores][:avg]
end
if pscore[:feedback]
f_max = pscore[:feedback][:scores][:max]
f_min = pscore[:feedback][:scores][:min]
f_avg = pscore[:feedback][:scores][:avg]
end
if pscore[:teammate]
tr_max = pscore[:teammate][:scores][:max]
tr_min = pscore[:teammate][:scores][:min]
tr_avg = pscore[:teammate][:scores][:avg]
end
</pre>
'''After:'''(views/grades/_participant.html.erb)
<pre>
if pscore[:review]
@rscore_review=Rscore.new(pscore,:review)
end
if pscore[:metareview]
@rscore_metareview=Rscore.new(pscore,:metareview)
end
if pscore[:feedback]
@rscore_feedback=Rscore.new(pscore,:feedback)
end
if pscore[:teammate]
@rscore_teammate=Rscore.new(pscore,:teammate)
</pre>

==Moving Calculation from view to model==
We move lots of calculations from views to model.

'''Before''':(views/grades/_participant.html.erb)
<pre>
<% if controller.action_name == 'view' or controller.action_name == "view_my_scores" %>
<TD ALIGN="CENTER">
<% if stage == "Finished" %>
<% if participant.grade
total_score = participant.grade
title = "A score in blue indicates that the value was overwritten by the instructor or teaching assistant."
else
total_score = pscore[:total_score]
title = nil
end %>

<% hardline = 85
if tr_avg > hardline
total_score = total_score + 0.05*total_score
elsif tr_avg < hardline and (hardline -tr_avg) > 40
total_score = total_score - 10
elsif tr_avg < hardline and (hardline -tr_avg) > 20
total_score = total_score - (hardline -tr_avg)*0.5
%>
<%end%>
<% if total_score>100
total_score = 100
%>
<%end%>
<div <% if title %>title="<%=title%>" style="color:#0033FF"<% end %>><%= sprintf("%.2f",total_score) %><%= score_postfix %></div>
</pre>
'''After''':(model/assignment_participant.rb)
<pre>
# move lots of calculation from view(_participant.html.erb) to model
if self.grade
scores[:total_score] = self.grade
end
else
total_score = scores[:total_score]
hardline = 85
if scores[:teammate][:scores][:avg].to_f > hardline
total_score = total_score + 0.05*total_score
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 40
total_score = total_score - 10
elsif scores[:teammate][:scores][:avg].to_f < hardline and (hardline - scores[:teammate][:scores][:avg].to_f) > 20
total_score = total_score - (hardline - scores[:teammate][:scores][:avg].to_f)*0.5
end
if total_score > 100
total_score = 100
end
scores[:total_score] = total_score
scores
</pre>

==Speeding up view score's function==
At the beginning of the final project, the function of viewing scores is very slow by students and instructor. Our team found the real factor which lead to the slow problem and solved it in an easy approach.
===Optimize response searching method in the model===
*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

===Test Result===
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Snapshots==
===Instructor Login===
[[File:Screens1.png|frame|center|]]
===Select Assignment===
[[File:Screens3.png|frame|center|]]
===View Scores===
[[File:Screens4.png|frame|center|]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

==Future Work==

We will stick to the UI design of the grades view and see what else we can do to further improve the performance of the system. We are trying to figure out other reasons that may lead to the bad performance in addition to the two main reasons mentioned and solved in E804 and E805 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T01:55:30Z

Jgu7: /* Details of Implementation */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T01:53:49Z

Jgu7: /* What we have done */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-03T01:04:26Z

Jgu7: /* Files Involved */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-11T00:15:02Z

Jgu7: /* Objected Oriented Design */

==Design Document==
E1472: Connect changes to score model with changes to score views

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.

== Requirements ==

'''A way to query db models to return scores, without UI changes'''

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

'''UI changes for reporting scores'''

The GradesController class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn’t have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

== Use Case==
[[File:usecase_score.png|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

'''Name:''' Student views his team score

'''Actor:''' Student

'''Other Participants:''' None

'''Precondition:''' At least team's score exists.

'''Primary Sequence:'''
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu

'''Name:''' Student views his team's review by other students

'''Actor:''' Student

'''Other Participants:''' None

'''Precondition:''' At least team's score exists.

'''Primary Sequence:'''
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page

'''Name''': Instructor or Teaching Assistant views the list of teams scores

'''Actor''': Instructor or Teaching Assistant

'''Other Participants''': None

'''Precondition''': At least one team's score exists.

'''Primary Sequence''':
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:uml.png |center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score is declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-11T00:14:01Z

Jgu7: /* Objected Oriented Design */

==Design Document==
E1472: Connect changes to score model with changes to score views

__TOC__

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.

== Requirements ==

'''A way to query db models to return scores, without UI changes'''

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

'''UI changes for reporting scores'''

The GradesController class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn’t have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

== Use Case==
[[File:usecase_score.png|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

'''Name:''' Student views his team score

'''Actor:''' Student

'''Other Participants:''' None

'''Precondition:''' At least team's score exists.

'''Primary Sequence:'''
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu

'''Name:''' Student views his team's review by other students

'''Actor:''' Student

'''Other Participants:''' None

'''Precondition:''' At least team's score exists.

'''Primary Sequence:'''
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page

'''Name''': Instructor or Teaching Assistant views the list of teams scores

'''Actor''': Instructor or Teaching Assistant

'''Other Participants''': None

'''Precondition''': At least one team's score exists.

'''Primary Sequence''':
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:uml.png |center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score are declared as subclass of RScore using ploymorphism. The type field is specified in their initialize method.

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-11T00:12:13Z

Jgu7: /* Objected Oriented Design */

==Design Document==
E1472: Connect changes to score model with changes to score views

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.

== Requirements ==

'''A way to query db models to return scores, without UI changes'''

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

'''UI changes for reporting scores'''

The GradesController class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn’t have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

== Use Case==
[[File:usecase_score.png|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

'''Name:''' Student views his team score

'''Actor:''' Student

'''Other Participants:''' None

'''Precondition:''' At least team's score exists.

'''Primary Sequence:'''
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu

'''Name:''' Student views his team's review by other students

'''Actor:''' Student

'''Other Participants:''' None

'''Precondition:''' At least team's score exists.

'''Primary Sequence:'''
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page

'''Name''': Instructor or Teaching Assistant views the list of teams scores

'''Actor''': Instructor or Teaching Assistant

'''Other Participants''': None

'''Precondition''': At least one team's score exists.

'''Primary Sequence''':
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:uml.png |center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score are declared as subclass of RScore. The type field is specified in their initialize method.

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

File:Uml.png

2014-11-11T00:10:40Z

Jgu7: uploaded a new version of "File:Uml.png"

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-11T00:10:23Z

Jgu7: /* Objected Oriented Design */

==Design Document==
E1472: Connect changes to score model with changes to score views

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.

== Requirements ==

'''A way to query db models to return scores, without UI changes'''

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

'''UI changes for reporting scores'''

The GradesController class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn’t have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

== Use Case==
[[File:usecase_score.png|center|]]

The figure above mainly illustrates the process of viewing scores for different actors. The instructor and teaching assistant are able to view scores of all the team and could see the reviews of a selected team. Student actor can see his own scores and reviews.

{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

'''Name:''' Student views his team score

'''Actor:''' Student

'''Other Participants:''' None

'''Precondition:''' At least team's score exists.

'''Primary Sequence:'''
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu

'''Name:''' Student views his team's review by other students

'''Actor:''' Student

'''Other Participants:''' None

'''Precondition:''' At least team's score exists.

'''Primary Sequence:'''
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu
*Select show_review in score page

'''Name''': Instructor or Teaching Assistant views the list of teams scores

'''Actor''': Instructor or Teaching Assistant

'''Other Participants''': None

'''Precondition''': At least one team's score exists.

'''Primary Sequence''':
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution.
[[File:uml.png |center|]]
The RScore class stores the variables maximum,minimum, average review scores. Different type of reviews score are declared as subclass of RScore

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

File:Uml.png

2014-11-10T23:02:42Z

Jgu7: uploaded a new version of "File:Uml.png"

File:Uml.png

2014-11-10T23:00:12Z

Jgu7: uploaded a new version of "File:Uml.png"

File:Uml.png

2014-11-10T22:59:24Z

Jgu7: uploaded a new version of "File:Uml.png"

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-10T22:59:01Z

Jgu7: /* Objected Oriented Design */

==Design Document==
E1472: Connect changes to score model with changes to score views

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.

== Requirements ==

'''A way to query db models to return scores, without UI changes'''

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

'''UI changes for reporting scores'''

The GradesController class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn’t have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

== Use Case==
[[File:usecase_score.png|center|]]

{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

'''Name:''' Student views his team score

'''Actor:''' Student

'''Other Participants:''' None

'''Precondition:''' At least team's score exists.

'''Primary Sequence:'''
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu

'''Name''': Instructor or Teaching Assistant viewing the list of teams scores

'''Actor''': Instructor or Teaching Assistant

'''Other Participants''': None

'''Precondition''': At least one team's score exists.

'''Primary Sequence''':
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution
[[File:uml.png]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-10T22:58:46Z

Jgu7: /* Objected Oriented Design */

==Design Document==
E1472: Connect changes to score model with changes to score views

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.

== Requirements ==

'''A way to query db models to return scores, without UI changes'''

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

'''UI changes for reporting scores'''

The GradesController class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn’t have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

== Use Case==
[[File:usecase_score.png|center|]]

{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

'''Name:''' Student views his team score

'''Actor:''' Student

'''Other Participants:''' None

'''Precondition:''' At least team's score exists.

'''Primary Sequence:'''
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu

'''Name''': Instructor or Teaching Assistant viewing the list of teams scores

'''Actor''': Instructor or Teaching Assistant

'''Other Participants''': None

'''Precondition''': At least one team's score exists.

'''Primary Sequence''':
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''Wiki page for E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''Wiki page for E805'']

[https://github.com/ajain2709/expertiza ''Github link for E912'']

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-10T22:55:17Z

Jgu7: /* Objected Oriented Design */

==Design Document==
E1472: Connect changes to score model with changes to score views

==Introduction==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. One of the Expertiza features is to report scores to both students and the instructor. The student can see the feedback from other students, such as the max score, the min score and the average score.

== Requirements ==

'''A way to query db models to return scores, without UI changes'''

These methods report grades to students and instructors. The view method reports everyone’s grades to an instructor, and the view_my_scores method reports peer-review scores to a student. This code is very slow, due to many factors. Two of the most prominent are the fact that separate db queries are used for each rubric that has been filled out by anyone associated with the assignment; these queries are made sequentially while the HTML page is being written; and the fact that HTML for the whole page is generated, largely by controller methods, before anything is displayed.

'''UI changes for reporting scores'''

The GradesController class is responsible for displaying grades to students (via view_my_scores) and instructors or Teaching Assistant (via the view method).
We will modify the Score class, and reduce the number of variables in order to remove code duplication and improve the loading speed.

===What we need to do===
*Remove the get_ and set_ accessor names; just use Ruby accessors.
*Change camel-case vs. underscores to match the Ruby convention.
*In grades/_participant.html.erb, don’t create local variables in the view; rather, create an object that has max, min, and avg fields for each kind of reviews. Try to avoid the need to check review type; instead, just pass the kind of review when referring to a max, min, or avg field and use polymorphism.
*Also, you shouldn’t have to check for the existence topic in the view; if it is null, a null string should just be returned.
*There are lots of calculations in the views, which should be moved to the model.

== Use Case==
[[File:usecase_score.png|center|]]

{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Actor
!style="background:#eFeFeF;"| Description

|-
| Instructor
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Teaching Assistant
| This actor is responsible for viewing scores and reviews of all the students(teams).

|-
| Student
| This actor is responsible for viewing scores and reviews of his own or of his team.

|}

'''Name:''' Student views his team score

'''Actor:''' Student

'''Other Participants:''' None

'''Precondition:''' At least team's score exists.

'''Primary Sequence:'''
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select Your Scores button from an Assignment menu

'''Name''': Instructor or Teaching Assistant viewing the list of teams scores

'''Actor''': Instructor or Teaching Assistant

'''Other Participants''': None

'''Precondition''': At least one team's score exists.

'''Primary Sequence''':
*Log in to Expertiza
*Choose Assignment from multiple Assignments
*Select View Scores button from an Assignment menu

==Objected Oriented Design==

The following class diagram shows a combination of new and existing classes along with the attributes and operations that are relevant to the implementation of this solution
[[File:uml.png]]

== See Also ==

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb ''E804'']

[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E805_kkn ''E805'']

[https://github.com/ajain2709/expertiza ''E912'']

File:Uml.png

2014-11-10T22:54:28Z

Jgu7: uploaded a new version of "File:Uml.png"

File:Uml.png

2014-11-10T22:53:51Z

Jgu7: uploaded a new version of "File:Uml.png"

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-10T22:52:39Z

Jgu7: /* Objected Oriented Design */

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T03:16:32Z

Jgu7: /* conflict_notification Method */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

'''What we have done:'''
*Modify '''calculate_all_penalties''' method.
*Refactor the '''conflict_notification''' method to '''conflict_email''' method.
*Simplify sending email function and make it delegated to the mailer.
*Send a conflict email to the reviewer automatically when instructor click the button "email reviewer".
*Remove '''get_body_text''' and '''send_grading_email''' method from grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' method.
*Search for the key reasons which lead to huge waiting time for getting score.
*Refactor '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.
*Eliminat the search for reviews and meta reviews during the '''grades_show''' method.
*Delete unnecessary instance Variables.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.The '''get_body_text''' and '''send_grading_email''' were removed from the controller. The sending email function is well simplified and delegated to a conflict_mailer.

====Design Pattern====
Delegation: The conflict_email should be able to send email. The class ConflictMailer works as its delegate .The conflict_email calls the send_conflict_email function to take the job of sending an email.

====Implementation====
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notifiction.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactorring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content which should be removed from controller.
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notifiction.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The querying reviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
In conflict_mailer.erb
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Confliction Email",from: sender.email,to: reviewer.email
end
</pre>
In its view send_conflict_email.txt.haml, we edit the email content.By this way, we deleted the '''get_body_text''' and well followed the rule of MVC design
<pre>
%h1="Hi ," +@recipient.name

%p="You submitted a score of "+@score+" for assignment "+@assignment.name+" that varied greatly from another "+@role+"'s score for the same "+@item+"."

%p="The Expertiza system has brought this to my attention."
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T03:15:13Z

Jgu7: /* Design Pattern */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

'''What we have done:'''
*Modify '''calculate_all_penalties''' method.
*Refactor the '''conflict_notification''' method to '''conflict_email''' method.
*Simplify sending email function and make it delegated to the mailer.
*Send a conflict email to the reviewer automatically when instructor click the button "email reviewer".
*Remove '''get_body_text''' and '''send_grading_email''' method from grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' method.
*Search for the key reasons which lead to huge waiting time for getting score.
*Refactor '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.
*Eliminat the search for reviews and meta reviews during the '''grades_show''' method.
*Delete unnecessary instance Variables.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.The '''get_body_text''' and '''send_grading_email''' were removed from the controller. The sending email function is well simplified and delegated to a conflict_mailer.

====Design Pattern====
Delegation: The conflict_email should be able to send email. The class ConflictMailer works as its delegate .The conflict_email calls the send_conflict_email function to take the job of sending an email.

====Implementation====
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notification.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactoring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content which should be removed from controller.
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notification.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The quering reiviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
In conflict_mailer.erb
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Conflication Email",from: sender.email,to: reviewer.email
end
</pre>
In its view send_conflict_email.txt.haml, we edit the email content.By this way, we deleted the '''get_body_text''' and well followed the rule of MVC design
<pre>
%h1="Hi ," +@recipient.name

%p="You submitted a score of "+@score+" for assignment "+@assignment.name+" that varied greatly from another "+@role+"'s score for the same "+@item+"."

%p="The Expertiza system has brought this to my attention."
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T03:14:38Z

Jgu7: /* Implementation */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

'''What we have done:'''
*Modify '''calculate_all_penalties''' method.
*Refactor the '''conflict_notification''' method to '''conflict_email''' method.
*Simplify sending email function and make it delegated to the mailer.
*Send a conflict email to the reviewer automatically when instructor click the button "email reviewer".
*Remove '''get_body_text''' and '''send_grading_email''' method from grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' method.
*Search for the key reasons which lead to huge waiting time for getting score.
*Refactor '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.
*Eliminat the search for reviews and meta reviews during the '''grades_show''' method.
*Delete unnecessary instance Variables.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.The '''get_body_text''' and '''send_grading_email''' were removed from the controller. The sending email function is well simplified and delegated to a conflict_mailer.

====Design Pattern====
Delegation: The conflict_email should be able to send email. The class ConflictMailer works as its delegate .The conflict_email calls the send_conflict_email fuction to take the job of sending a email.

====Implementation====
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notification.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactoring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content which should be removed from controller.
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notification.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The quering reiviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
In conflict_mailer.erb
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Conflication Email",from: sender.email,to: reviewer.email
end
</pre>
In its view send_conflict_email.txt.haml, we edit the email content.By this way, we deleted the '''get_body_text''' and well followed the rule of MVC design
<pre>
%h1="Hi ," +@recipient.name

%p="You submitted a score of "+@score+" for assignment "+@assignment.name+" that varied greatly from another "+@role+"'s score for the same "+@item+"."

%p="The Expertiza system has brought this to my attention."
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T03:14:25Z

Jgu7: /* Design Pattern */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

'''What we have done:'''
*Modify '''calculate_all_penalties''' method.
*Refactor the '''conflict_notification''' method to '''conflict_email''' method.
*Simplify sending email function and make it delegated to the mailer.
*Send a conflict email to the reviewer automatically when instructor click the button "email reviewer".
*Remove '''get_body_text''' and '''send_grading_email''' method from grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' method.
*Search for the key reasons which lead to huge waiting time for getting score.
*Refactor '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.
*Eliminat the search for reviews and meta reviews during the '''grades_show''' method.
*Delete unnecessary instance Variables.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.The '''get_body_text''' and '''send_grading_email''' were removed from the controller. The sending email function is well simplified and delegated to a conflict_mailer.

====Design Pattern====
Delegation: The conflict_email should be able to send email. The class ConflictMailer works as its delegate .The conflict_email calls the send_conflict_email fuction to take the job of sending a email.

===Implementation===
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notification.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactoring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content which should be removed from controller.
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notification.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The quering reiviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
In conflict_mailer.erb
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Conflication Email",from: sender.email,to: reviewer.email
end
</pre>
In its view send_conflict_email.txt.haml, we edit the email content.By this way, we deleted the '''get_body_text''' and well followed the rule of MVC design
<pre>
%h1="Hi ," +@recipient.name

%p="You submitted a score of "+@score+" for assignment "+@assignment.name+" that varied greatly from another "+@role+"'s score for the same "+@item+"."

%p="The Expertiza system has brought this to my attention."
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T03:13:55Z

Jgu7: /* Design Pattern */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

'''What we have done:'''
*Modify '''calculate_all_penalties''' method.
*Refactor the '''conflict_notification''' method to '''conflict_email''' method.
*Simplify sending email function and make it delegated to the mailer.
*Send a conflict email to the reviewer automatically when instructor click the button "email reviewer".
*Remove '''get_body_text''' and '''send_grading_email''' method from grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' method.
*Search for the key reasons which lead to huge waiting time for getting score.
*Refactor '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.
*Eliminat the search for reviews and meta reviews during the '''grades_show''' method.
*Delete unnecessary instance Variables.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.The '''get_body_text''' and '''send_grading_email''' were removed from the controller. The sending email function is well simplified and delegated to a conflict_mailer.

===Design Pattern===
Delegation: The conflict_email should be able to send email. The class ConflictMailer works as its delegate .The conflict_email calls the send_conflict_email fuction to take the job of sending a email.

===Implementation===
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notification.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactoring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content which should be removed from controller.
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notification.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The quering reiviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
In conflict_mailer.erb
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Conflication Email",from: sender.email,to: reviewer.email
end
</pre>
In its view send_conflict_email.txt.haml, we edit the email content.By this way, we deleted the '''get_body_text''' and well followed the rule of MVC design
<pre>
%h1="Hi ," +@recipient.name

%p="You submitted a score of "+@score+" for assignment "+@assignment.name+" that varied greatly from another "+@role+"'s score for the same "+@item+"."

%p="The Expertiza system has brought this to my attention."
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T02:47:56Z

Jgu7: /* Design Pattern */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

'''What we have done:'''
*Modify '''calculate_all_penalties''' method.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactored view_my_scores method to grades_show method.
*Searched for the key reasons which lead to huge waiting time for getting score.
*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.
*Eliminated the search for reviews during the grades_show method.
*Deleted unnecessary instance Variables.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.The '''get_body_text''' and '''send_grading_email''' were removed from the controller. The sending email function is well simplified and delegated to a conflict_mailer.

===Design Pattern===
Delegation: The conflict_email should be able to send email. The class ConflictMailer works as its delegate .The conflict_email calls the send_conflict_email fuction to take the job of sending a email.

====Implementation====
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notification.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactoring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content which should be removed from controller.
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notification.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The quering reiviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
In conflict_mailer.erb
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Conflication Email",from: sender.email,to: reviewer.email
end
</pre>
In its view send_conflict_email.txt.haml, we edit the email content.By this way, we deleted the '''get_body_text''' and well followed the rule of MVC design
<pre>
%h1="Hi ," +@recipient.name

%p="You submitted a score of "+@score+" for assignment "+@assignment.name+" that varied greatly from another "+@role+"'s score for the same "+@item+"."

%p="The Expertiza system has brought this to my attention."
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T02:45:57Z

Jgu7: /* Summary */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

'''What we have done:'''
*Modify '''calculate_all_penalties''' method.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactored view_my_scores method to grades_show method.
*Searched for the key reasons which lead to huge waiting time for getting score.
*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.
*Eliminated the search for reviews during the grades_show method.
*Deleted unnecessary instance Variables.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.The '''get_body_text''' and '''send_grading_email''' were removed from the controller. The sending email function is well simplified and delegated to a conflict_mailer.

===Design Pattern===
Delegation: The conflict_email should be able to send email. The class ConflictMailer works as its delegate and takes the job to send a email.The conflict_email calls the

====Implementation====
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notification.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactoring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content which should be removed from controller.
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notification.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The quering reiviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
In conflict_mailer.erb
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Conflication Email",from: sender.email,to: reviewer.email
end
</pre>
In its view send_conflict_email.txt.haml, we edit the email content.By this way, we deleted the '''get_body_text''' and well followed the rule of MVC design
<pre>
%h1="Hi ," +@recipient.name

%p="You submitted a score of "+@score+" for assignment "+@assignment.name+" that varied greatly from another "+@role+"'s score for the same "+@item+"."

%p="The Expertiza system has brought this to my attention."
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T02:45:14Z

Jgu7: /* Summary */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

'''What we have done:'''
*Modify '''calculate_all_penalties''' method.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactored view_my_scores method to grades_show method.
*Searched for the key reasons which lead to huge waiting time for getting score.
*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.
*Eliminated the search for reviews during the grades_show method.
*Deleted unnecessary instance Variables.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.The '''get_body_text''' and '''send_grading_email''' were removed from the controller. The sending email function is well simplified and using delegated to a conflict_mailer.
===Design Pattern===
Delegation: The conflict_email should be able to send email. The class ConflictMailer works as its delegate and takes the job to send a email.The conflict_email calls the

====Implementation====
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notification.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactoring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content which should be removed from controller.
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notification.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The quering reiviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
In conflict_mailer.erb
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Conflication Email",from: sender.email,to: reviewer.email
end
</pre>
In its view send_conflict_email.txt.haml, we edit the email content.By this way, we deleted the '''get_body_text''' and well followed the rule of MVC design
<pre>
%h1="Hi ," +@recipient.name

%p="You submitted a score of "+@score+" for assignment "+@assignment.name+" that varied greatly from another "+@role+"'s score for the same "+@item+"."

%p="The Expertiza system has brought this to my attention."
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T02:36:47Z

Jgu7: /* Implementation */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.

====Implementation====
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notification.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactoring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content which should be removed from controller.
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notification.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The quering reiviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
In conflict_mailer.erb
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Conflication Email",from: sender.email,to: reviewer.email
end
</pre>
In its view send_conflict_email.txt.haml, we edit the email content.By this way, we deleted the '''get_body_text''' and well followed the rule of MVC design
<pre>
%h1="Hi ," +@recipient.name

%p="You submitted a score of "+@score+" for assignment "+@assignment.name+" that varied greatly from another "+@role+"'s score for the same "+@item+"."

%p="The Expertiza system has brought this to my attention."
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T02:34:28Z

Jgu7: /* Implementation */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.

====Implementation====
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notification.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactoring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content also in controller
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notification.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The quering reiviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
In conflict_mailer.erb
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Conflication Email",from: sender.email,to: reviewer.email
end
</pre>
In its view send_conflict_email.txt.haml, we edit the email content.By this way, we deleted the '''get_body_text''' and well followed the rule of MVC design
<pre>
%h1="Hi ," +@recipient.name

%p="You submitted a score of "+@score+" for assignment "+@assignment.name+" that varied greatly from another "+@role+"'s score for the same "+@item+"."

%p="The Expertiza system has brought this to my attention."
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T02:32:26Z

Jgu7: /* Implementation */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.

====Implementation====
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notification.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactoring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content also in controller
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notification.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The quering reiviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
In conflict_mailer.erb
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Conflication Email",from: sender.email,to: reviewer.email
end
</pre>
In its view send_conflict_email.txt.haml, we construct the email content.By this way, we follow the rule of MVC design
<pre>
%h1="Hi ," +@recipient.name

%p="You submitted a score of "+@score+" for assignment "+@assignment.name+" that varied greatly from another "+@role+"'s score for the same "+@item+"."

%p="The Expertiza system has brought this to my attention."
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==

CSC/ECE 517 Fall 2014/OSS E1466 gjf

2014-10-27T02:29:03Z

Jgu7: /* Implementation */

==E1466: Refactoring GradesController==

This wiki deals with our implementation of a controller in expertiza: [https://github.com/expertiza/expertiza/blob/rails4/app/controllers/grades_controller.rb grade_controller] for the Expertiza Project using Ruby on Rails.

== Introduction ==

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities.

==Project Description==
<br>
'''Classes involved:''' grades_controller.rb

'''What it does:'''

This class lists the grades of all the participants for an assignments and also their reviews. Instructor can edit scores, calculate penalties and send emails for conflicts.

'''What needs to be done:'''

*Modify '''calculate_all_penalties''' method which is too complex and long.
*Put the '''get_body_text''' method in a mailer rather than in the grades_controller.
*Refactor '''conflict_nofication''' method to '''conflict_email''' and make it delegated to the mailer.
*Refactor '''view_my_scores''' method to '''grades_show''' and delete the unnecessary variables.
*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.
*Try not to query for reviews and meta reviews in '''grades_show''' method.

==Code Modification==

=== calculate_all_penalties Method===
====Summary====

We have modified the calculate_penalties method and implemented all the functions it originally has. After our modification the method shrinks from 45 lines to 32 lines of Ruby code. Originally, the method includes a lot of unnecessary if and unless statements which makes the method uneasy to read and seems to have a difficult logic to calculate the penalties.

According to the [https://codeclimate.com codeclimate] which calculate the complexity of the method, originally, it has a complexity of '''85''', however, after we modified it, the complexity goes down to '''65'''. Please check at [https://codeclimate.com/github/expertiza/expertiza/GradesController original version],[https://codeclimate.com/github/maxlpy/expertiza/GradesController modified version]

We have done the following to the original methods:

*Used for loop with selective choice to create penalty attributes and put it into the '''CalculatedPenalty''' Table, instead of duplicating the almost same code.

*Used Object-Oriented Design patterns of Ruby: let the array respond to the method '''min''' which returns the minimum number in the array and get the logical penalty other than using if statement.(max_penalty if total_penalty is larger than max_penalty, total_penalty if total_penalty is smaller than max_penalty)

*Eliminated the unnecessary if statements to make the code clear to read.

====Implementation====

*Modify if statements:

Before Refactoring:
<pre>
if(penalties[:submission].nil?)
penalties[:submission]=0
end
if(penalties[:review].nil?)
penalties[:review]=0
end
if(penalties[:meta_review].nil?)
penalties[:meta_review]=0
end
</pre>
After Refactoring:
<pre>
penalties[:submission] = 0 if penalties[:submission].nil?
penalties[:review] = 0 if penalties[:review].nil?
penalties[:meta_review] = 0 if penalties[:meta_review].nil?
</pre>

*Using Objected-oriented Pattern
Before Refactoring:
<pre>
if(@total_penalty > l_policy.max_penalty)
@total_penalty = l_policy.max_penalty
end
</pre>
After Refactoring:
<pre>
@total_penality=[l_policy.max_penalty,@total_penality].min
</pre>
*Using loops rather than duplicate same code
Before Refactoring:
<pre>
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)"
@all_penalties[participant.id] = Hash.new
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>
After Refactoring:
<pre>
deadline_type=[1,2,5]
penalty_type=[:submission,:review,:meta_review]
if calculate_for_participants
for i in 0..2
penalty_attr={:deadline_type_id=>deadline_type[i],:participant_id => @participant.id, :penalty_points => penalties[penalty_type[i]]}
CalculatedPenalty.create(penalty_attr)
end
end
@all_penalties[participant.id] = {}
for i in 0..2
@all_penalties[participant.id][:penalty_type[i]] = penalties[:penalty_type[i]]
end
@all_penalties[participant.id][:total_penalty] = @total_penalty"
</pre>

=== conflict_notification Method===

====Summary====
We refactored the '''conflict_notification''' method to '''conflict_email''' method. When instructor click the button "email reviewer" whom he thought give a unfair review, the system should be able to send an email to the reviewer automatically.

====Implementation====
The old '''conflict_notification''' action queries an email address list of a certain kind of reviews. In its view conflict_notification.html.erb, A email form contains email list for instructor to choose from and email content.
[[File:old_email.png]]

'''Before Refactoring''', in conflict_notification:
First,Get the instructor email address as sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
</pre>
Then,Based on submission of review, the action query all the reviewers' email address
<pre>
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
</pre>
The email list is for instructor to choose from. The process_response method queries the email address.
<pre>
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
</pre>
The get_body_text method construct email content also in controller
<pre>
@body = get_body_text(params[:submission])
</pre>

The conflict_notification action requiring another two method "process_response" and "get_body_text" method to get the recipient email list and email content which contributes to extra complexity. The instructor only have to click the button "send email" in conflict_notification.html.erb and turn to send_conflict_email action, then he/she can send the email. If the instructor want to send another email, the process will repeat again,which will be terrible when reloading the "view" scores page.

'''After Refactoring''':The quering reiviews actually have done in our show_reviews action, and we can get the individual reviewers' email address.In the reviewer table,we add extra button "email reviewer".Now the instructor could send to reviewer email directly.
[[File:conflict_email.png]]

In _review_table.html.erb,we add the link to send email. The review_id is passed to the conflict_email action taken as the recipient.
<pre>
<%= link_to 'email reviewer', :action => 'conflict_email',:remote=> true,:reviewer_id=>

review.map.reviewer.user,:participant_id=>participant,:score=>sprintf("%.2f",score) %>
</pre>

In our new '''conflict_email''' action:

We still need the instructor as the sender
<pre>
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
</pre>
The reviewer_id is passed from the link,we can query his/her email address to send the email
<pre>
recipient=User.find(params[:reviewer_id])
</pre>
The responsibility of sending email has been delegated to a new mailer conflict_mailer. And the email content was constructed in the mailer.
<pre>
participant = AssignmentParticipant.find(params[:participant_id])
assignment=Assignment.find(participant.parent_id)
score=params[:score]
ConflictMailer.send_conflict_email(instructor,recipient,assignment,score).deliver

</pre>
Take a look at new conflict_mailer, it define a '''send_conflict_email''' method. the email was sent from sender's email and to reviewer's email.Some instance variables were used in view.
<pre>
def send_conflict_email(sender,recipient,assignment,score)
@assignment=assignment
@recipient=recipient
@score=score
if recipient.role_id==1
@role = "reviewer"
@item = "submission"
else
@role = "metareviewer"
@item = "review"
end
mail subject: "Conflication Email",from: sender.email,to: reviewer.email
end
</pre>

The link "email reviewer" request a ajax,so the current view page will not refresh when the action done
<pre>
respond_to do |format|
format.js
end
</pre>
If an email was successfully sent,The instructor should get the alert window by ajax.
[[File:email_sent.png]]

=== view_my_scores method===

====Summary====
We refactored '''view_my_scores''' method to grades_show, deleted many unnecessary instance variables along with several review and meta reviews methods inside it. Therefore, the system will only search for scores in the database rather than search for scores and reviews, which wastes a lot of time during the grade show process. After refactoring, the complexity on this decreased from '''53''' to '''35'''.
We also optimize '''get_scores''' method to improve the efficiency of showing scores by students and instructors, which cost us most of the time during the project. After refactoring this method, the time cost of views in grade controller decreased by more than '''90%'''.

We have done the following to the original methods:

*Refactored '''view_my_scores''' method to '''grades_show''' method.

*Searched for the key reasons which lead to huge waiting time for getting score.

*Refactored '''get_assessments_for''' method in response_map.rb and lead to more than 90% off the current waiting time.

*Eliminated the search for reviews during the '''grades_show''' method.

*Deleted unnecessary instance Variables.

====Implementation====
*Deleted the unnecessary instance variables

Deleted Code:
<pre>
@average_score_results = Array.new
@average_score_results = ScoreCache.get_class_scores(@participant.id)
@statistics = Array.new
@average_score_results.each { |x|
@statistics << x
}
</pre>

*Deleted query for reviews and meta_reviews

Deleted Code:
<pre>
@average_reviews = ScoreCache.get_reviews_average(@participant.id)
@average_metareviews = ScoreCache.get_metareviews_average(@participant.id)
@my_reviews = ScoreCache.my_reviews(@participant.id)
@my_metareviews = ScoreCache.my_metareviews(@participant.id)
</pre>

*Modify '''get_assessments_for''' method in response_map.rb
After doing this, the time cost of view function decreased by more than 90%
Before Refactoring:
<pre>
# the original method to find all response
@all_resp=Response.all
for element in @all_resp
if (element.map_id == map.map_id)
@array_sort << element
@test << map
end
end
</pre>

After Refactoring:
<pre>
@all_resp=Response.find_by_map_id(map.map_id)
@array_sort << @all_resp
@test << map
</pre>

*Add a new method into grades_controller.rb

Add Method:
<pre>
#show_reviews method gets reviews, meta reviews and author feedback information from server.
def show_reviews
@partial='grades/'+params[:path]
@prefix=params[:prefix]
@score=Hash.new
@score[:assessments]=Array.new
params[:score][:assessments].each do |assessment|
@score[:assessments]<<Response.find(assessment)
end
@score[:scores]=params[:score][:scores]
@participant=AssignmentParticipant.find(params[:participant])
@assignment = @participant.assignment
@questions = {}
questionnaires = @assignment.questionnaires
questionnaires.each do |questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
end
end
</pre>

*Change view_my_score.html.erb into show_reviews.html.erb in views.

*Add in views(show_reviews.html.erb)

<pre>
<%= render :partial=>@partial, :locals => {:prefix => @prefix, :participant => @participant, :rscore => @score} %>
</pre>

====Test Result====
*The following test results based on the test case on Expertiza(Assignments: Program 2 style)
{| class="wikitable" style="font-size: 90%;"
|+ style="font-size: 1.25em;" |
|-
!style="background:#eFeFeF;"| Name
!style="background:#eFeFeF;"| Before Refactoring
!style="background:#eFeFeF;"| After Refactoring
!style="background:#eFeFeF;"| Reduced By

|-
| View all team's score(instructor)
| 484988ms
| 8642ms
| 98.21%
|-
| View own score(student)
| 8941ms
| 651ms
| 92.71%
|}

*Original Time for Instructor to View all scores

[[File:Instructor_old.png‎|frame|center|Original Time for Instructor to View all scores]]

*Time for Instructor to View all scores after Refactoring

[[File:Instructor_new.png‎|frame|center|Time for Instructor to View all scores after Refactoring]]

*Original Time for Student to View all scores

[[File:Student_old.png‎|frame|center|Original Time for Student to View all scores]]

*Time for Student to View all scores after Refactoring

[[File:Student_new.png‎|frame|center|Time for Student to View all scores after Refactoring]]

==Appendix==

==References==