Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-12-05T02:20:26Z

Sxu11: /* Encapsulation */

==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===
'''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 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 maintenance. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in model, which encapsulated all these three variables. Whenever we need the value of min, max and avg, we can get those 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-05T02:17:21Z

Sxu11: /* Encapsulation */

==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===
'''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 obtains 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 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 maintenance. Since min, max and avg are the mostly used variables, we created a new data structure '''Rscore''' in model, 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 ==

[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-05T02:10:27Z

Sxu11: /* What we need to do */

==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===
'''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 obtains 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.get_scores''' method in gradesController, so we move these calculations into get_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 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 ==

[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-04T14:38:53Z

Sxu11: /* See Also */

==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 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 obtains 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.get_scores method in gradesController, so we move these calculations into get_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 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 ==

[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-04T05:51:20Z

Sxu11: /* What we have done */

==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 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 obtains 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.get_scores method in gradesController, so we move these calculations into get_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 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 ==

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

[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-04T05:50:58Z

Sxu11: /* What we are going to do */

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

*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 obtains 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.get_scores method in gradesController, so we move these calculations into get_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 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 ==

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

[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-03T22:45:28Z

Sxu11: /* What we have done */

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

*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 obtains 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.get_scores method in gradesController, so we move these calculations into get_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 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 ==

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

[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-03T16:34:55Z

Sxu11: /* See Also */

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

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 obtains 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.get_scores method in gradesController, so we move these calculations into get_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 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 ==

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

[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:05:10Z

Sxu11: /* User Guide */

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

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

Sxu11: /* Introduction */

==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:01:34Z

Sxu11: /* What we have done */

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

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-11-29T04:44:29Z

Sxu11: /* What we are going to do */

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

'''Controller''':
*grades_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.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.

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

===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-11-29T04:44:09Z

Sxu11: /* What we are going to do */

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

'''Controller''':
*grades_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

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

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

*We will 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.

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

===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-11-29T04:43:00Z

Sxu11: /* What we are going to do */

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

'''Controller''':
*grades_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

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

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

*We will modify the setters and getters in the models/participant.rb

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

*Modify getter methods in models

*delete checking for topics in views

*We will also 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.

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

===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-11-29T03:39:59Z

Sxu11: /* What we have done */

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

'''Controller''':
*grades_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

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

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also 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.

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

===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-11-29T03:38:40Z

Sxu11: /* What we are going to do */

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

'''Controller''':
*grades_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

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

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also 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.

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

===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-11-29T03:38:24Z

Sxu11: /* What we have done */

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

'''Controller''':
*grades_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

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

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also 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.

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

===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-11-29T03:38:05Z

Sxu11: /* MVC design pattern */

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

'''Controller''':
*grades_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

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

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also 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.

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

===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-11-29T03:37:17Z

Sxu11: /* DRY Principle */

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

'''Controller''':
*grades_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

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

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also 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.

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

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.

===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-11-29T03:22:25Z

Sxu11: /* Single Responsibility Principle */

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

'''Controller''':
*grades_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

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

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also 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 removed the calculations in the views into model file,assignment_participants.rb, which follows the single responsibility principle and DRY principle.

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

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.
===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-11-29T03:21:35Z

Sxu11: /* What we have done */

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

'''Controller''':
*grades_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

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

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also 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 removed the calculations in the views into model file,assignment_participants.rb, which follows the single responsibility principle and DRY principle.

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

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.
===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.

== 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-11-29T03:20:20Z

Sxu11: /* What we have done */

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

'''Controller''':
*grades_controller.rb

'''View''':

*grades/_participant.html.erb

*grades/_scores_author_feedback.html.erb

*grades/_scores_metareview.html.erb

*grades/_scores_submitted_work.html.erb

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

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also 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.

*

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

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.
===Single Responsibility Principle===
This ensures that every controller and model method will be responsible in performing exactly one functionality.

== 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-11-29T03:18:36Z

Sxu11: /* What we have done */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-29T03:16:58Z

Sxu11: /* Requirements */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-29T02:34:02Z

Sxu11: /* Files Involved */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-29T02:33:15Z

Sxu11: /* What we are going to do */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-22T17:40:38Z

Sxu11: /* Files Involved */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-22T17:35:15Z

Sxu11: /* Use Case */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-22T17:31:50Z

Sxu11: /* Use Case */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-22T17:30:38Z

Sxu11: /* Use Case */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-22T17:29:13Z

Sxu11: /* Use Case */

File:Use case 2.png

2014-11-22T17:28:34Z

Sxu11:

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-19T05:37:17Z

Sxu11: /* Design Document */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-19T05:35:52Z

Sxu11: /* What we are going to do */

==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===
*grades_controller.rb.

*grades/_participant.html.erb

*models/participant.rb

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also move the calculations in the views to the controller so that there won't be many calculations in the views of MVC framework.

== Design Pattern and Principles ==

For this project, we will use the MVC design pattern. Model–view–controller (MVC) is a software architectural pattern for implementing user interfaces. It divides a given software application (such as web application) into three interconnected parts, so as to separate internal representations of information from the ways that information is presented to or accepted from the user.

The above diagram is an architecture of the MVC model with 3 components, and the interaction among them.

'''Components'''

The central component of MVC, the model, captures the behavior of the application in terms of its problem domain, independent of the user interface. The model directly manages the data, logic and rules of the application. A view can be any output representation of information, such as a chart or a diagram; multiple views of the same information are possible, such as a bar chart for management and a tabular view for accountants. The third part, the controller, accepts input and converts it to commands for the model or view.

'''Interactions'''

In addition to dividing the application into three kinds of components, the model–view–controller design defines the interactions between them.

*A controller can send commands to the model to update the model's state (e.g., editing a document). It can also send commands to its associated view to change the view's presentation of the model (e.g., by scrolling through a document).
*A model notifies its associated views and controllers when there has been a change in its state. This notification allows the views to produce updated output, and the controllers to change the available set of commands. In some cases an MVC implementation might instead be "passive," so that other components must poll the model for updates rather than being notified.
*A view requests information from the model that it uses to generate an output representation to the user.

==System Architecture==

[[File:Expertiza Architecture.png‎|frame|center|]]

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

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

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

== Use Case==

[[File:Use_case.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: 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.

|}

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 or Teaching Assistant views the list of teams scores || Instructor or Teaching Assistant || 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: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.

==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-11-19T05:35:41Z

Sxu11: /* What we are going to do */

==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===
*grades_controller.rb.

*grades/_participant.html.erb

*models/participant.rb

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also move the calculations in the views to the controller so that there won't be many calculations in the views of MVC framework.

== Design Pattern and Principles ==

For this project, we will use the MVC design pattern. Model–view–controller (MVC) is a software architectural pattern for implementing user interfaces. It divides a given software application (such as web application) into three interconnected parts, so as to separate internal representations of information from the ways that information is presented to or accepted from the user.

The above diagram is an architecture of the MVC model with 3 components, and the interaction among them.

'''Components'''

The central component of MVC, the model, captures the behavior of the application in terms of its problem domain, independent of the user interface. The model directly manages the data, logic and rules of the application. A view can be any output representation of information, such as a chart or a diagram; multiple views of the same information are possible, such as a bar chart for management and a tabular view for accountants. The third part, the controller, accepts input and converts it to commands for the model or view.

'''Interactions'''

In addition to dividing the application into three kinds of components, the model–view–controller design defines the interactions between them.

*A controller can send commands to the model to update the model's state (e.g., editing a document). It can also send commands to its associated view to change the view's presentation of the model (e.g., by scrolling through a document).
*A model notifies its associated views and controllers when there has been a change in its state. This notification allows the views to produce updated output, and the controllers to change the available set of commands. In some cases an MVC implementation might instead be "passive," so that other components must poll the model for updates rather than being notified.
*A view requests information from the model that it uses to generate an output representation to the user.

==System Architecture==

[[File:Expertiza Architecture.png‎|frame|center|]]

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

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

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

== Use Case==

[[File:Use_case.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: 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.

|}

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 or Teaching Assistant views the list of teams scores || Instructor or Teaching Assistant || 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: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.

==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-11-19T05:27:03Z

Sxu11: /* Future Work */

==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===
*grades_controller.rb.

*grades/_participant.html.erb

*models/participant.rb

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also move the calculations in the views to the controller so that there won't be many calculations in the views of MVC framework.

== Design Pattern and Principles ==

For this project, we will use the MVC design pattern. Model–view–controller (MVC) is a software architectural pattern for implementing user interfaces. It divides a given software application (such as web application) into three interconnected parts, so as to separate internal representations of information from the ways that information is presented to or accepted from the user.

The above diagram is an architecture of the MVC model with 3 components, and the interaction among them.

'''Components'''

The central component of MVC, the model, captures the behavior of the application in terms of its problem domain, independent of the user interface. The model directly manages the data, logic and rules of the application. A view can be any output representation of information, such as a chart or a diagram; multiple views of the same information are possible, such as a bar chart for management and a tabular view for accountants. The third part, the controller, accepts input and converts it to commands for the model or view.

'''Interactions'''

In addition to dividing the application into three kinds of components, the model–view–controller design defines the interactions between them.

*A controller can send commands to the model to update the model's state (e.g., editing a document). It can also send commands to its associated view to change the view's presentation of the model (e.g., by scrolling through a document).
*A model notifies its associated views and controllers when there has been a change in its state. This notification allows the views to produce updated output, and the controllers to change the available set of commands. In some cases an MVC implementation might instead be "passive," so that other components must poll the model for updates rather than being notified.
*A view requests information from the model that it uses to generate an output representation to the user.

==System Architecture==

[[File:Expertiza Architecture.png‎|frame|center|]]

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

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

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

== Use Case==

[[File:Use_case.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.

|}

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 or Teaching Assistant views the list of teams scores || Instructor or Teaching Assistant || 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: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.

==Snapshots==
===Instructor Login===
[[File:Screens3.png]]

===Select Assignment===
===View Scores===

== 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-11-19T05:26:42Z

Sxu11: /* Future Work */

==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===
*grades_controller.rb.

*grades/_participant.html.erb

*models/participant.rb

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also move the calculations in the views to the controller so that there won't be many calculations in the views of MVC framework.

== Design Pattern and Principles ==

For this project, we will use the MVC design pattern. Model–view–controller (MVC) is a software architectural pattern for implementing user interfaces. It divides a given software application (such as web application) into three interconnected parts, so as to separate internal representations of information from the ways that information is presented to or accepted from the user.

The above diagram is an architecture of the MVC model with 3 components, and the interaction among them.

'''Components'''

The central component of MVC, the model, captures the behavior of the application in terms of its problem domain, independent of the user interface. The model directly manages the data, logic and rules of the application. A view can be any output representation of information, such as a chart or a diagram; multiple views of the same information are possible, such as a bar chart for management and a tabular view for accountants. The third part, the controller, accepts input and converts it to commands for the model or view.

'''Interactions'''

In addition to dividing the application into three kinds of components, the model–view–controller design defines the interactions between them.

*A controller can send commands to the model to update the model's state (e.g., editing a document). It can also send commands to its associated view to change the view's presentation of the model (e.g., by scrolling through a document).
*A model notifies its associated views and controllers when there has been a change in its state. This notification allows the views to produce updated output, and the controllers to change the available set of commands. In some cases an MVC implementation might instead be "passive," so that other components must poll the model for updates rather than being notified.
*A view requests information from the model that it uses to generate an output representation to the user.

==System Architecture==

[[File:Expertiza Architecture.png‎|frame|center|]]

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

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

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

== Use Case==

[[File:Use_case.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.

|}

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 or Teaching Assistant views the list of teams scores || Instructor or Teaching Assistant || 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: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.

==Snapshots==
===Instructor Login===
[[File:Screens3.png]]

===Select Assignment===
===View Scores===

== 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 E814 and E815 projects.

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-19T05:16:06Z

Sxu11: /* See Also */

==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===
*grades_controller.rb.

*grades/_participant.html.erb

*models/participant.rb

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also move the calculations in the views to the controller so that there won't be many calculations in the views of MVC framework.

==System Architecture==
[[File:Expertiza Architecture.png‎|frame|center|]]

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

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

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

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

|}

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 or Teaching Assistant views the list of teams scores || Instructor or Teaching Assistant || 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
|}

== Design Pattern and Principle ==

For this project, we will use the MVC design pattern. Model–view–controller (MVC) is a software architectural pattern for implementing user interfaces. It divides a given software application (such as web application) into three interconnected parts, so as to separate internal representations of information from the ways that information is presented to or accepted from the user.

[[File:MVC-Process.png|center|]]

The above diagram is an architecture of the MVC model with 3 components, and the interaction among them.

'''Components'''

The central component of MVC, the model, captures the behavior of the application in terms of its problem domain, independent of the user interface. The model directly manages the data, logic and rules of the application. A view can be any output representation of information, such as a chart or a diagram; multiple views of the same information are possible, such as a bar chart for management and a tabular view for accountants. The third part, the controller, accepts input and converts it to commands for the model or view.

'''Interactions'''

In addition to dividing the application into three kinds of components, the model–view–controller design defines the interactions between them.

*A controller can send commands to the model to update the model's state (e.g., editing a document). It can also send commands to its associated view to change the view's presentation of the model (e.g., by scrolling through a document).
*A model notifies its associated views and controllers when there has been a change in its state. This notification allows the views to produce updated output, and the controllers to change the available set of commands. In some cases an MVC implementation might instead be "passive," so that other components must poll the model for updates rather than being notified.
*A view requests information from the model that it uses to generate an output representation to the user.

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

==Future Work==

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-19T05:13:42Z

Sxu11: /* Requirements */

==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===
*grades_controller.rb.

*grades/_participant.html.erb

*models/participant.rb

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

*We will modify the setters and getters in the models/participant.rb

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

*We will also move the calculations in the views to the controller so that there won't be many calculations in the views of MVC framework.

==System Architecture==
[[File:Expertiza Architecture.png‎|frame|center|]]

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

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

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

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

|}

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 or Teaching Assistant views the list of teams scores || Instructor or Teaching Assistant || 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
|}

== Design Pattern and Principle ==

For this project, we will use the MVC design pattern. Model–view–controller (MVC) is a software architectural pattern for implementing user interfaces. It divides a given software application (such as web application) into three interconnected parts, so as to separate internal representations of information from the ways that information is presented to or accepted from the user.

[[File:MVC-Process.png|center|]]

The above diagram is an architecture of the MVC model with 3 components, and the interaction among them.

'''Components'''

The central component of MVC, the model, captures the behavior of the application in terms of its problem domain, independent of the user interface. The model directly manages the data, logic and rules of the application. A view can be any output representation of information, such as a chart or a diagram; multiple views of the same information are possible, such as a bar chart for management and a tabular view for accountants. The third part, the controller, accepts input and converts it to commands for the model or view.

'''Interactions'''

In addition to dividing the application into three kinds of components, the model–view–controller design defines the interactions between them.

*A controller can send commands to the model to update the model's state (e.g., editing a document). It can also send commands to its associated view to change the view's presentation of the model (e.g., by scrolling through a document).
*A model notifies its associated views and controllers when there has been a change in its state. This notification allows the views to produce updated output, and the controllers to change the available set of commands. In some cases an MVC implementation might instead be "passive," so that other components must poll the model for updates rather than being notified.
*A view requests information from the model that it uses to generate an output representation to the user.

==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-19T04:49:54Z

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

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

===Files Involved===
*grades_controller.rb.

*grades/_participant.html.erb

==System Architecture==
[[File:Expertiza Architecture.png‎|frame|center|]]

===Views===
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. A couple of problems were that:

*In the original expertiza application, all the reviews given to a user were listed one after another and this made finding a particular review very difficult.

*Also, when an admin clicked on view scores for an assignment, the time overhead to display the assignments was too high and this had to be taken care of.

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

====view====

The 'view' method is responsible for handling 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====

The 'view_my_scores' method takes care of displaying the scores pertaining to an assignment to a single user.

In the controller methods, some amount of code pertaining to views too was initially coded. This code was refactored and made central to the views only so as to avoid duplication.

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

Method get_total_scores() was making multiple sequential queries to the database to calculate scores. This method has been modified to retrieve data from a view. This view has been created in the database by migration “CreateMyViews”. Also, a new method ubmission_valid?' has been created to check whether the review is valid or not. This functionality was previously included in get_total_scores().

New model classes PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

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

|}

{| class="wikitable"
|-
! Name !! Actor !! other paticipants || 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 or Teaching Assistant views the list of teams scores || Instructor or Teaching Assistant || 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
|}

== Design Pattern and Principle ==

For this project, we will use the MVC design pattern. Model–view–controller (MVC) is a software architectural pattern for implementing user interfaces. It divides a given software application (such as web application) into three interconnected parts, so as to separate internal representations of information from the ways that information is presented to or accepted from the user.

[[File:MVC-Process.png|center|]]

The above diagram is an architecture of the MVC model with 3 components, and the interaction among them.

'''Components'''

The central component of MVC, the model, captures the behavior of the application in terms of its problem domain, independent of the user interface. The model directly manages the data, logic and rules of the application. A view can be any output representation of information, such as a chart or a diagram; multiple views of the same information are possible, such as a bar chart for management and a tabular view for accountants. The third part, the controller, accepts input and converts it to commands for the model or view.

'''Interactions'''

In addition to dividing the application into three kinds of components, the model–view–controller design defines the interactions between them.

*A controller can send commands to the model to update the model's state (e.g., editing a document). It can also send commands to its associated view to change the view's presentation of the model (e.g., by scrolling through a document).
*A model notifies its associated views and controllers when there has been a change in its state. This notification allows the views to produce updated output, and the controllers to change the available set of commands. In some cases an MVC implementation might instead be "passive," so that other components must poll the model for updates rather than being notified.
*A view requests information from the model that it uses to generate an output representation to the user.

==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-19T04:49:37Z

Sxu11: /* Requirements */

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

===Files Involved===
1.grades_controller.rb.
2.grades/_participant.html.erb

==System Architecture==
[[File:Expertiza Architecture.png‎|frame|center|]]

===Views===
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. A couple of problems were that:

*In the original expertiza application, all the reviews given to a user were listed one after another and this made finding a particular review very difficult.

*Also, when an admin clicked on view scores for an assignment, the time overhead to display the assignments was too high and this had to be taken care of.

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

====view====

The 'view' method is responsible for handling 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====

The 'view_my_scores' method takes care of displaying the scores pertaining to an assignment to a single user.

In the controller methods, some amount of code pertaining to views too was initially coded. This code was refactored and made central to the views only so as to avoid duplication.

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

Method get_total_scores() was making multiple sequential queries to the database to calculate scores. This method has been modified to retrieve data from a view. This view has been created in the database by migration “CreateMyViews”. Also, a new method ubmission_valid?' has been created to check whether the review is valid or not. This functionality was previously included in get_total_scores().

New model classes PartcipantScores.rb and AssignmentScores.rb have been created to retrieve the scores for participant and assignment respectively.

== 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:''' TA views teams' review

'''Actor:''' TA

'''Other Participants:''' None

'''Precondition:''' At least team's review 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

{| class="wikitable"
|-
! Name !! Actor !! other paticipants || 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 or Teaching Assistant views the list of teams scores || Instructor or Teaching Assistant || 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
|}

== Design Pattern and Principle ==

For this project, we will use the MVC design pattern. Model–view–controller (MVC) is a software architectural pattern for implementing user interfaces. It divides a given software application (such as web application) into three interconnected parts, so as to separate internal representations of information from the ways that information is presented to or accepted from the user.

[[File:MVC-Process.png|center|]]

The above diagram is an architecture of the MVC model with 3 components, and the interaction among them.

'''Components'''

The central component of MVC, the model, captures the behavior of the application in terms of its problem domain, independent of the user interface. The model directly manages the data, logic and rules of the application. A view can be any output representation of information, such as a chart or a diagram; multiple views of the same information are possible, such as a bar chart for management and a tabular view for accountants. The third part, the controller, accepts input and converts it to commands for the model or view.

'''Interactions'''

In addition to dividing the application into three kinds of components, the model–view–controller design defines the interactions between them.

*A controller can send commands to the model to update the model's state (e.g., editing a document). It can also send commands to its associated view to change the view's presentation of the model (e.g., by scrolling through a document).
*A model notifies its associated views and controllers when there has been a change in its state. This notification allows the views to produce updated output, and the controllers to change the available set of commands. In some cases an MVC implementation might instead be "passive," so that other components must poll the model for updates rather than being notified.
*A view requests information from the model that it uses to generate an output representation to the user.

==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-10T23:39:50Z

Sxu11: /* Use Case */

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

== 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-10T23:39:09Z

Sxu11: /* Use Case */

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

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-10T23:37:40Z

Sxu11: /* Use Case */

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

CSC/ECE 517 Fall 2014

2014-11-10T23:07:25Z

Sxu11:

*[[CSC/ECE_517_Fall_2014/sample_page]]
*[[CSC/ECE_517_Fall_2014/ch1a 22 as]]
*[[CSC/ECE 517 Fall 2014/ch1a 19 mx]]
*[[CSC/ECE 517 Fall 2014/ch1a 3 zq]]
*[[CSC/ECE 517 Fall 2014/ch1a 4 lf]]
*[[CSC/ECE 517 Fall 2014/ch1a 4 wl]]
*[[CSC/ECE 517 Fall 2014/ch1a a7 ch]]
*[[CSC/ECE 517 Fall 2014/ch1a 25 rs]]
*[[CSC/ECE 517 Fall 2014/ch1a 25 jf]]
*[[CSC/ECE 517 Fall 2014/ch1a 8 os]]
*[[CSC/ECE 517 Fall 2014/ch1a 8 sn]]
*[[CSC/ECE 517 Fall 2014/ch1a 15 gs]]
*[[CSC/ECE 517 Fall 2014/ch1a 10 hu]]
*[[CSC/ECE 517 Fall 2014/ch1a 20 kv]]
*[[CSC/ECE 517 Fall 2014/ch1a 21 as]]
*[[CSC/ECE 517 Fall 2014/ch1a 24 sa]]
*[[CSC/ECE 517 Fall 2014/ch1a 26 sn]]
*[[CSC/ECE 517 Fall 2014/ch1a 6 rl]]
*[[CSC/ECE 517 Fall 2014/ch1a 2 ss]]
*[[CSC/ECE 517 Fall 2014/ch1a 16 av]]
*[[CSC/ECE 517 Fall 2014/ch1a 1 rm]]
*[[CSC/ECE 517 Fall 2014/ch1a 1 sj]]
*[[CSC/ECE 517 Fall 2014/ch1a 23 ss]]
*[[CSC/ECE 517 Fall 2014/ch1a 20 rn]]
*[[CSC/ECE 517 Fall 2014/ch1a 22 sp]]
*[[CSC/ECE 517 Fall 2014/oss M1454 rss]]

*[[CSC/ECE 517 Fall 2014/ch1a 26 gn]]

*[[CSC/ECE 517 Fall 2014/ch1a 13 va]]
*[[CSC/ECE 517 Fall 2014/ch1a 9 aa]]
*[[CSC/ECE 517 Fall 2014/ch1a 9 kn]]
*[[CSC/ECE 517 Fall 2014/ch1a 11 ap]]
*[[CSC/ECE 517 Fall 2014/ch1a 25 ks]]
*[[CSC/ECE 517 Fall 2014/ch1a 7 kz]]
*[[CSC/ECE_517_Fall_2014/ch1a_6_bn]]
*[[CSC/ECE_517_Fall_2014/ch1a 10 zz]]
*[[CSC/ECE_517_Fall_2014/ch1a 16 va]]
*[[CSC/ECE_517_Fall_2014/ch1a F1415 rv]]
*[[CSC/ECE_517_Fall_2014/ch1a_3_cp]]
*[[CSC/ECE 517 Fall 2014/ch1b 26 sa]]
*[[CSC/ECE_517_Fall_2014/ch1b_28_cg]]
*[[CSC/ECE_517_Fall_2014/ch1b 29 ry]]
*[[CSC/ECE_517_Fall_2014/ch1b 30 cs]]
*[[CSC/ECE_517_Fall_2014/ch1b_33_jy]]
*[[CSC/ECE_517_Fall_2014/ch1b_27_js]]
*[[CSC/ECE 517 Fall 2014/oss E1453 syy]]
*[[CSC/ECE 517 Fall 2014/oss E1463 vpd]]
*[[CSC/ECE 517 Fall 2014/oss E1465 oak]]
*[[CSC/ECE 517 Fall 2014/oss_M1456_kdv]]
*[[CSC/ECE 517 Fall 2014/oss_M1453_sst]]
*[[CSC/ECE 517 Fall 2014/oss_E1456_akk]]
*[[CSC/ECE_517_Fall_2014/oss_M1455_asa]]
*[[CSC/ECE_517_Fall_2014/oss_E1458_sst]]
*[[CSC/ECE_517_Fall_2014/oss_E1457_ags]]
*[[CSC/ECE_517_Fall_2014/OSS_E1466_gjf]]
*[[CSC/ECE_517_Fall_2014/oss_M1452_jns]]
*[[CSC/ECE_517_Fall_2014/oss_E1462_nms]]
*[[CSC/ECE_517_Fall_2014/OSS_S1455_ajp]]
*[[CSC/ECE_517_Fall_2014/OSS_S1454_ccc]]
*[[CSC/ECE_517_Fall_2014/OSS_E1450_cxm]]
*[[CSC/ECE_517_Fall_2014/OSS_E1455_skn]]
*[[CSC/ECE_517_Fall_2014/OSS_M1450_vda]]
*[[CSC/ECE_517_Fall_2014/OSS_E1467_rsv]]
*[[CSC/ECE_517_Fall_2014/OSS_E1464_vnn]]
*[[CSC/ECE 517 Fall 2014/OSS_M1451_ahs]]
*[[CSC/ECE 517 Fall 2014/OSS_E1451_las]]
*[[CSC/ECE 517 Fall 2014/OSS_E1461_knn]]
*[[CSC/ECE_517_Fall_2014/oss_E1460_aua]]
*[[CSC/ECE_517_Fall_2014/oss_E1459_jjr]]
*[[CSC/ECE_517_Fall_2014/final_E1474_akkn]]
*[[CSC/ECE_517_Fall_2014/final_E1472_gjfz]]

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-10T00:30:51Z

Sxu11: /* a */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-10T00:16:22Z

Sxu11: /* a */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-10T00:08:40Z

Sxu11: /* a */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-10T00:07:28Z

Sxu11: /* a */

CSC/ECE 517 Fall 2014/final E1472 gjfz

2014-11-10T00:04:51Z

Sxu11: /* Use Case */