Expertiza_Wiki - User contributions [en]

MainPage

2014-09-08T13:47:35Z

Knjhaver: /* Course-Specific Topics */

==Course-Specific Topics==
* [[CSC 216]] learning exercise
* [[CSC 379]]
* [[CSC/ECE 506 Fall 2007]]
* [[ECE506_Main_Page | CSC/ECE 506 Main Portal]]
* [[CSC/ECE 517 Fall 2007]]
* [[CSC/ECE 517 Summer 2008]]
* [[CSC/ECE 517 Fall 2010]]
* [[CSC/ECE 517 Fall 2011]]
* [[CSC/ECE 517 Fall 2012]]
* [[CSC/ECE 517 Fall 2013]]
* [[CSC/ECE 517 Fall 2014]]
* [[CSC/ECE 517 Spring 2014]]
* [[CSC 456 Spring 2011|CSC 456 Spring 2012]]
* [[ECE 633]]
* [[KCU]]
* [[Progress reports]]

==Application Behavior==
* [[Grading]]

==Metaprogramming==
* [[CSC/ECE_517_Spring_2013/ch1b_1k_hf|Lecture on Metaprogramming]]

==Development==

''Expertiza now has a Java dependency, so the machine you are using to develop Expertiza on should have the JVM installed.''

* [[Setting Up a Development Machine]]
* [[Creating a Linux Development Environment for Expertiza - Installation Guide]]
* [[Using git and github for projects]]
* [[Using heroku to deploy your projects]]
* [[How to Begin a Project from the Current Expertiza Repository]]
* [[Git]]
* [[How to Change a User's Password on a Development Machine]]
* [[Debugging Rails]]

==Production==
* [[Deploying to Production]]
* [[Downloading Production Data]]
* [[Accessing the Production Server]]

==Testing==
* [[Using Cucumber with Expertiza]]
* [[Rails Testing Overview]]
* [[Expertiza Continuous Integration]]

==Design==
* [[Object-Oriented Design and Programming]]

Downloading Production Data

2014-08-27T13:39:00Z

Knjhaver:

== Rails 3 ==
<code>
cd <your_github_repository>
bundle install
bundle exec cap -v
ruby -v
source /etc/profile
rvm use 1.8.7
rails -v
bundle exec rails -v
bundle exec rake db:setup
# Create tunnel in another window:
ssh -L 127.0.0.1:2222:expertiza.ncsu.edu:22 <your-realm-id>@remote.eos.ncsu.edu
Leave this tunnel open while executing the following commands.
bundle exec cap proxy load_data
[When prompted to log in:
Proxy server: localhost
Login: <your-realm-id>
Port: 22
Password: <realm pw.>]
bundle exec rake db:migrate
</code>

== Rails 4 ==
cd <your_github_repository>
bundle install
bundle exec cap -v
ruby -v
source /etc/profile
rvm use 1.8.7
rails -v
bundle exec rails -v
bundle exec rake db:setup
[Create tunnel in another window:
ssh -L 127.0.0.1:2222:expertiza.ncsu.edu:22 <your-realm-id>@remote.eos.ncsu.edu
Leave this tunnel open while executing the following commands.]
bundle exec cap proxy db:pull
[When prompted to log in:
Proxy server: localhost
Login: <your-realm-id>
Port: 22
Password: <realm pw.>]
bundle exec rake db:migrate

Downloading Production Data

2014-08-27T13:33:51Z

Knjhaver:

Rails 3:
cd <your_github_repository>
bundle install
bundle exec cap -v
ruby -v
source /etc/profile
rvm use 1.8.7
rails -v
bundle exec rails -v
bundle exec rake db:setup
[Create tunnel in another window:
ssh -L 127.0.0.1:2222:expertiza.ncsu.edu:22 <your-realm-id>@remote.eos.ncsu.edu
Leave this tunnel open while executing the following commands.]
bundle exec cap proxy load_data
[When prompted to log in:
Proxy server: localhost
Login: <your-realm-id>
Port: 22
Password: <realm pw.>]
bundle exec rake db:migrate

Rails 4:
cd <your_github_repository>
bundle install
bundle exec cap -v
ruby -v
source /etc/profile
rvm use 1.8.7
rails -v
bundle exec rails -v
bundle exec rake db:setup
[Create tunnel in another window:
ssh -L 127.0.0.1:2222:expertiza.ncsu.edu:22 <your-realm-id>@remote.eos.ncsu.edu
Leave this tunnel open while executing the following commands.]
bundle exec cap proxy load_data
[When prompted to log in:
Proxy server: localhost
Login: <your-realm-id>
Port: 22
Password: <realm pw.>]
bundle exec rake db:migrate

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T02:08:34Z

Knjhaver:

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:untitled2_kj.jpg]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[File:untitled1_kj.jpg]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.

[[File:Screenshot2.jpg]]

==Code Changes==
Before modification the code, all the partials for the score rendering were included in the view_my_scores.html.erb.This led to all the partials being rendered at the same time.

[[File:Submit.png]]

We have now refactored the code such that the view_my_scores.html.erb partial includes other partials.Each of these partials corresponds to a tab in the view-my-scores page.
[[File:Newview_my_scores.png]]

As shown in the figure we have separated the code based on the tab that the user clicks. Therefore, we have introduced one more layer of partials which will help facilitate the rendering of the data based on user action. Thus, only the necessary page will be rendered on the click of a tab.The corresponding partial function will have the appropriate call to the controller. This will get the code only to the tab which the user has clicked
[[File:One_new_partial.png]]

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb e804] which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

==Appendix==
Expertiza VCL image: http://152.46.19.82:3000/
Forked GitHub Repository: https://github.com/krunaljhaveri/expertiza

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T02:03:58Z

Knjhaver: /* Code Changes */

File:Submit.png

2013-11-03T02:02:38Z

Knjhaver: uploaded a new version of "File:Submit.png"

File:Newview my scores.png

2013-11-03T02:01:14Z

Knjhaver: uploaded a new version of "File:Newview my scores.png"

File:One new partial.png

2013-11-03T01:59:53Z

Knjhaver: uploaded a new version of "File:One new partial.png"

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T01:57:52Z

Knjhaver: /* Code Changes */

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T01:56:55Z

Knjhaver: /* Code Changes */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:untitled2_kj.jpg]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[File:untitled1_kj.jpg]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.

[[File:Screenshot2.jpg]]

==Code Changes==
Before modification the code, all the partials for the score rendering were included in the view_my_scores.html.erb.This led to all the partials being rendered at the same time.

[[File:Submit.png]]

We have now refactored the code such that the view_my_scores.html.erb partial includes other partials.Each of these partials corresponds to a tab in the view-my-scores page.
[[File:Newview_my_scores.png]]

<div id="tabs">
<ul>
<li id="tab1"><a href="#tabs-11">Submitted Work</a></li>
<li id="tab2"><a href="#tabs-12">Reviewing</a></li>
<li id="tab3"><a href="#tabs-13">Author Feedback</a></li>
<li id="tab4"><a href="#tabs-14">TeamMate Review</a></li>
<li id="tab5"><a href="#tabs-15">Total Score</a></li>
</ul>
<div id="tabs-11">
<p><%= render :partial => 'grades/submittedwork', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %> </p>
</div>
<div id="tabs-12">
<%= render :partial => 'grades/meta', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</div>
<div id="tabs-13">
<%= render :partial => 'grades/author',:locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</div>
<div id="tabs-14">
<%= render :partial => 'grades/teammate',:locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</div>
<div id="tabs-15">
<%= render 'grades/scores' %>
</div>
</div>
<script>
jQuery(document).ready(function () {
jQuery("#tabs").tabs();
});
</script>

As shown in the figure we have separated the code based on the tab that the user clicks. Therefore, we have introduced one more layer of partials which will help facilitate the rendering of the data based on user action. Thus, only the necessary page will be rendered on the click of a tab.The corresponding partial function will have the appropriate call to the controller. This will get the code only to the tab which the user has clicked
[[File:One_new_partial.png]]

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb e804] which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T01:56:02Z

Knjhaver: /* Code Changes */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:untitled2_kj.jpg]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[File:untitled1_kj.jpg]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.

[[File:Screenshot2.jpg]]

==Code Changes==
Before modification the code, all the partials for the score rendering were included in the view_my_scores.html.erb.This led to all the partials being rendered at the same time.

[[File:Submit.png]]

We have now refactored the code such that the view_my_scores.html.erb partial includes other partials.Each of these partials corresponds to a tab in the view-my-scores page.
[[File:Newview_my_scores.png]]

<div id="tabs">
<ul>
<li id="tab1"><a href="#tabs-11">Submitted Work</a></li>
<li id="tab2"><a href="#tabs-12">Reviewing</a></li>
<li id="tab3"><a href="#tabs-13">Author Feedback</a></li>
<li id="tab4"><a href="#tabs-14">TeamMate Review</a></li>
<li id="tab5"><a href="#tabs-15">Total Score</a></li>
</ul>
<div id="tabs-11">
<p><%= render :partial => 'grades/submittedwork', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %> </p>
</div>
<div id="tabs-12">
<%= render :partial => 'grades/meta', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</div>
<div id="tabs-13">
<%= render :partial => 'grades/author',:locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</div>
<div id="tabs-14">
<%= render :partial => 'grades/teammate',:locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</div>
<div id="tabs-15">
<%= render 'grades/scores' %>
</div>
</div>
<script>
jQuery(document).ready(function () {
jQuery("#tabs").tabs();
});
</script>

As shown in the figure we have separated the code based on the tab that the user clicks. Therefore, we have introduced one more layer of partials which will help facilitate the rendering of the data based on user action. Thus, only the necessary page will be rendered on the click of a tab.The corresponding partial function will have the appropriate call to the controller. This will get the code only to the tab which the user has clicked
[[File:One_new_partial.png]]

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb e804] which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T01:54:55Z

Knjhaver: /* Code Changes */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:untitled2_kj.jpg]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[File:untitled1_kj.jpg]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.

[[File:Screenshot2.jpg]]

==Code Changes==
Before modification the code, all the partials for the score rendering were included in the view_my_scores.html.erb.This led to all the partials being rendered at the same time.

[[File:Submit.png]]

We have now refactored the code such that the view_my_scores.html.erb partial includes other partials.Each of these partials corresponds to a tab in the view-my-scores page.
[[File:Newview_my_scores.png]]

<div id="tabs">
<ul>
<li id="tab1"><a href="#tabs-11">Submitted Work</a></li>
<li id="tab2"><a href="#tabs-12">Reviewing</a></li>
<li id="tab3"><a href="#tabs-13">Author Feedback</a></li>
<li id="tab4"><a href="#tabs-14">TeamMate Review</a></li>
<li id="tab5"><a href="#tabs-15">Total Score</a></li>
</ul>
<div id="tabs-11">
<p><%= render :partial => 'grades/submittedwork', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %> </p>
</div>
<div id="tabs-12">
<%= render :partial => 'grades/meta', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</div>
<div id="tabs-13">
<%= render :partial => 'grades/author',:locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</div>
<div id="tabs-14">
<%= render :partial => 'grades/teammate',:locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</div>
<div id="tabs-15">
<%= render 'grades/scores' %>
</div>
</div>
<script>
jQuery(document).ready(function () {
jQuery("#tabs").tabs();
});
</script>

As shown in the figure we have separated the code based on the tab that the user clicks. Therefore, we have introduced one more layer of partials which will help facilitate the rendering of the data based on user action. Thus, only the necessary page will be rendered on the click of a tab.The corresponding partial function will have the appropriate call to the controller. This will get the code only to the tab which the user has clicked
[[File:One_new_partial.png]]

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb e804] which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

File:Screenshot2.jpg

2013-11-03T01:53:00Z

Knjhaver: uploaded a new version of "File:Screenshot2.jpg"

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T01:52:04Z

Knjhaver: /* Modified User Interface to view scores and reviews in tabs */

File:Screenshot2.jpg

2013-11-03T01:51:23Z

Knjhaver:

File:Untitled2 kj.jpg

2013-11-03T01:37:57Z

Knjhaver: uploaded a new version of "File:Untitled2 kj.jpg"

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T01:35:04Z

Knjhaver: /* Initial User Interface to view scores */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:untitled2_kj.jpg]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[File:untitled1_kj.jpg]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.

[[File:twoFinal805.png]]

==Code Changes==
Before modification the code, all the partials for the score rendering were included in the view_my_scores.html.erb.This led to all the partials being rendered at the same time.

[[File:Submit.png]]

We have now refactored the code such that the view_my_scores.html.erb partial includes other partials.Each of these partials corresponds to a tab in the view-my-scores page.
[[File:Newview_my_scores.png]]

As shown in the figure we have separated the code based on the tab that the user clicks. Therefore, we have introduced one more layer of partials which will help facilitate the rendering of the data based on user action. Thus, only the necessary page will be rendered on the click of a tab.The corresponding partial function will have the appropriate call to the controller. This will get the code only to the tab which the user has clicked
[[File:One_new_partial.png]]

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb e804] which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T01:34:32Z

Knjhaver: /* Problem Inference and Motivation */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:untitled2_kj.jpg]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[File:untitled1_kj.jpg]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.
[[File:scr1.png]]

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.

[[File:twoFinal805.png]]

==Code Changes==
Before modification the code, all the partials for the score rendering were included in the view_my_scores.html.erb.This led to all the partials being rendered at the same time.

[[File:Submit.png]]

We have now refactored the code such that the view_my_scores.html.erb partial includes other partials.Each of these partials corresponds to a tab in the view-my-scores page.
[[File:Newview_my_scores.png]]

As shown in the figure we have separated the code based on the tab that the user clicks. Therefore, we have introduced one more layer of partials which will help facilitate the rendering of the data based on user action. Thus, only the necessary page will be rendered on the click of a tab.The corresponding partial function will have the appropriate call to the controller. This will get the code only to the tab which the user has clicked
[[File:One_new_partial.png]]

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb e804] which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T01:33:06Z

Knjhaver: /* Problem Inference and Motivation */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:untitled_kj2.jpg]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[File:untitled_kj.jpg]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.
[[File:scr1.png]]

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.

[[File:twoFinal805.png]]

==Code Changes==
Before modification the code, all the partials for the score rendering were included in the view_my_scores.html.erb.This led to all the partials being rendered at the same time.

[[File:Submit.png]]

We have now refactored the code such that the view_my_scores.html.erb partial includes other partials.Each of these partials corresponds to a tab in the view-my-scores page.
[[File:Newview_my_scores.png]]

As shown in the figure we have separated the code based on the tab that the user clicks. Therefore, we have introduced one more layer of partials which will help facilitate the rendering of the data based on user action. Thus, only the necessary page will be rendered on the click of a tab.The corresponding partial function will have the appropriate call to the controller. This will get the code only to the tab which the user has clicked
[[File:One_new_partial.png]]

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb e804] which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

File:Untitled2 kj.jpg

2013-11-03T01:32:05Z

Knjhaver:

File:Untitled1 kj.jpg

2013-11-03T01:31:48Z

Knjhaver:

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T01:26:43Z

Knjhaver: /* Problem Inference and Motivation */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:untitled_kj2.png]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[File:untitled_kj.png]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.
[[File:scr1.png]]

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.

[[File:twoFinal805.png]]

==Code Changes==
Before modification the code, all the partials for the score rendering were included in the view_my_scores.html.erb.This led to all the partials being rendered at the same time.

[[File:Submit.png]]

We have now refactored the code such that the view_my_scores.html.erb partial includes other partials.Each of these partials corresponds to a tab in the view-my-scores page.
[[File:Newview_my_scores.png]]

As shown in the figure we have separated the code based on the tab that the user clicks. Therefore, we have introduced one more layer of partials which will help facilitate the rendering of the data based on user action. Thus, only the necessary page will be rendered on the click of a tab.The corresponding partial function will have the appropriate call to the controller. This will get the code only to the tab which the user has clicked
[[File:One_new_partial.png]]

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb e804] which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

File:Untitled kj2.png

2013-11-03T01:26:20Z

Knjhaver:

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-11-03T01:25:51Z

Knjhaver: /* Problem Inference and Motivation */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:scr1.png]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[File:untitled_kj.png]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.
[[File:scr1.png]]

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.

[[File:twoFinal805.png]]

==Code Changes==
Before modification the code, all the partials for the score rendering were included in the view_my_scores.html.erb.This led to all the partials being rendered at the same time.

[[File:Submit.png]]

We have now refactored the code such that the view_my_scores.html.erb partial includes other partials.Each of these partials corresponds to a tab in the view-my-scores page.
[[File:Newview_my_scores.png]]

As shown in the figure we have separated the code based on the tab that the user clicks. Therefore, we have introduced one more layer of partials which will help facilitate the rendering of the data based on user action. Thus, only the necessary page will be rendered on the click of a tab.The corresponding partial function will have the appropriate call to the controller. This will get the code only to the tab which the user has clicked
[[File:One_new_partial.png]]

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb e804] which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

File:Untitled kj.png

2013-11-03T01:24:42Z

Knjhaver:

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T02:08:37Z

Knjhaver: /* Future Work */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:scr1.png]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[File:scr1.png]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.
==Code Changes==
:Score for <%= @assignment.name %>

<TABLE class="grades" >
<%= render :partial => 'grades/participant_title', :locals => {:prefix => nil} %>
<%= render :partial => 'grades/participant', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</TABLE>
<BR/>
<a href="javascript:window.history.back()">Back</a>

The code below included all the partials like _submissions.html.erb, _reviews.html.erb, _metareviews.html.erb in the same HTML page i.e. _participant.html.erb
<TR class="row" id="<%= prefix %>_files" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/submissions', :locals => {:participant => participant} %></TD> </TR>
<TR class="row" id="<%= prefix %>_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD></TR>
<TR class="row" id="<%= prefix %>_mreviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/metareviews', :locals => {:prefix => prefix, :participant => participant, :rscore => pscore[:metareview]} %></TD></TR>
<TR class="row" id="<%= prefix %>_teammate_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/teammate_reviews', :locals => {:prefix =>prefix, :participant => participant, :rscore => pscore[:teammate]} %></TD></TR>
<TR class="row" id="<%= prefix %>_feedback" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/author_feedbacks', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:feedback]} %></TD></TR>

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/oss_E804_spb e804] which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T02:05:22Z

Knjhaver: /* Problem Inference and Motivation */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:scr1.png]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[File:scr1.png]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.
==Code Changes==
:Score for <%= @assignment.name %>

<TABLE class="grades" >
<%= render :partial => 'grades/participant_title', :locals => {:prefix => nil} %>
<%= render :partial => 'grades/participant', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</TABLE>
<BR/>
<a href="javascript:window.history.back()">Back</a>

The code below included all the partials like _submissions.html.erb, _reviews.html.erb, _metareviews.html.erb in the same HTML page i.e. _participant.html.erb
<TR class="row" id="<%= prefix %>_files" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/submissions', :locals => {:participant => participant} %></TD> </TR>
<TR class="row" id="<%= prefix %>_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD></TR>
<TR class="row" id="<%= prefix %>_mreviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/metareviews', :locals => {:prefix => prefix, :participant => participant, :rscore => pscore[:metareview]} %></TD></TR>
<TR class="row" id="<%= prefix %>_teammate_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/teammate_reviews', :locals => {:prefix =>prefix, :participant => participant, :rscore => pscore[:teammate]} %></TD></TR>
<TR class="row" id="<%= prefix %>_feedback" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/author_feedbacks', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:feedback]} %></TD></TR>

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with E804 which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T02:04:38Z

Knjhaver: /* Problem Inference and Motivation */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[scr1:scr1.png]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[scr1.png]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.
==Code Changes==
:Score for <%= @assignment.name %>

<TABLE class="grades" >
<%= render :partial => 'grades/participant_title', :locals => {:prefix => nil} %>
<%= render :partial => 'grades/participant', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</TABLE>
<BR/>
<a href="javascript:window.history.back()">Back</a>

The code below included all the partials like _submissions.html.erb, _reviews.html.erb, _metareviews.html.erb in the same HTML page i.e. _participant.html.erb
<TR class="row" id="<%= prefix %>_files" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/submissions', :locals => {:participant => participant} %></TD> </TR>
<TR class="row" id="<%= prefix %>_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD></TR>
<TR class="row" id="<%= prefix %>_mreviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/metareviews', :locals => {:prefix => prefix, :participant => participant, :rscore => pscore[:metareview]} %></TD></TR>
<TR class="row" id="<%= prefix %>_teammate_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/teammate_reviews', :locals => {:prefix =>prefix, :participant => participant, :rscore => pscore[:teammate]} %></TD></TR>
<TR class="row" id="<%= prefix %>_feedback" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/author_feedbacks', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:feedback]} %></TD></TR>

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with E804 which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T02:04:24Z

Knjhaver: /* Problem Inference and Motivation */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[File:scr1.png]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[scr1.png]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.
==Code Changes==
:Score for <%= @assignment.name %>

<TABLE class="grades" >
<%= render :partial => 'grades/participant_title', :locals => {:prefix => nil} %>
<%= render :partial => 'grades/participant', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</TABLE>
<BR/>
<a href="javascript:window.history.back()">Back</a>

The code below included all the partials like _submissions.html.erb, _reviews.html.erb, _metareviews.html.erb in the same HTML page i.e. _participant.html.erb
<TR class="row" id="<%= prefix %>_files" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/submissions', :locals => {:participant => participant} %></TD> </TR>
<TR class="row" id="<%= prefix %>_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD></TR>
<TR class="row" id="<%= prefix %>_mreviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/metareviews', :locals => {:prefix => prefix, :participant => participant, :rscore => pscore[:metareview]} %></TD></TR>
<TR class="row" id="<%= prefix %>_teammate_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/teammate_reviews', :locals => {:prefix =>prefix, :participant => participant, :rscore => pscore[:teammate]} %></TD></TR>
<TR class="row" id="<%= prefix %>_feedback" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/author_feedbacks', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:feedback]} %></TD></TR>

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with E804 which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

File:Scr2.png

2013-10-31T02:03:21Z

Knjhaver: uploaded a new version of "File:Scr2.png"

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T02:02:30Z

Knjhaver: /* Problem Inference and Motivation */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.
[[scr1.png]]

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.
[[scr1.png]]

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.
==Code Changes==
:Score for <%= @assignment.name %>

<TABLE class="grades" >
<%= render :partial => 'grades/participant_title', :locals => {:prefix => nil} %>
<%= render :partial => 'grades/participant', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</TABLE>
<BR/>
<a href="javascript:window.history.back()">Back</a>

The code below included all the partials like _submissions.html.erb, _reviews.html.erb, _metareviews.html.erb in the same HTML page i.e. _participant.html.erb
<TR class="row" id="<%= prefix %>_files" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/submissions', :locals => {:participant => participant} %></TD> </TR>
<TR class="row" id="<%= prefix %>_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD></TR>
<TR class="row" id="<%= prefix %>_mreviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/metareviews', :locals => {:prefix => prefix, :participant => participant, :rscore => pscore[:metareview]} %></TD></TR>
<TR class="row" id="<%= prefix %>_teammate_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/teammate_reviews', :locals => {:prefix =>prefix, :participant => participant, :rscore => pscore[:teammate]} %></TD></TR>
<TR class="row" id="<%= prefix %>_feedback" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/author_feedbacks', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:feedback]} %></TD></TR>

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with E804 which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

File:Scr2.png

2013-10-31T02:02:19Z

Knjhaver:

File:Src1.png

2013-10-31T02:00:22Z

Knjhaver:

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T01:57:45Z

Knjhaver: /* Problem Inference and Motivation */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with reviews,metareviews,author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface design.

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.
The implementation of this design involved the separation of the code that ……..

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.
==Code Changes==
:Score for <%= @assignment.name %>

<TABLE class="grades" >
<%= render :partial => 'grades/participant_title', :locals => {:prefix => nil} %>
<%= render :partial => 'grades/participant', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</TABLE>
<BR/>
<a href="javascript:window.history.back()">Back</a>

The code below included all the partials like _submissions.html.erb, _reviews.html.erb, _metareviews.html.erb in the same HTML page i.e. _participant.html.erb
<TR class="row" id="<%= prefix %>_files" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/submissions', :locals => {:participant => participant} %></TD> </TR>
<TR class="row" id="<%= prefix %>_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD></TR>
<TR class="row" id="<%= prefix %>_mreviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/metareviews', :locals => {:prefix => prefix, :participant => participant, :rscore => pscore[:metareview]} %></TD></TR>
<TR class="row" id="<%= prefix %>_teammate_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/teammate_reviews', :locals => {:prefix =>prefix, :participant => participant, :rscore => pscore[:teammate]} %></TD></TR>
<TR class="row" id="<%= prefix %>_feedback" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/author_feedbacks', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:feedback]} %></TD></TR>

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with E804 which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T01:57:15Z

Knjhaver: /* Project Description */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

===Problem Inference and Motivation===
*Currently the view_my_scores html.erb page displays all the scores in a tabular form with
reviews,metareviews,author feedback below each other. Everything is merged into one big html
page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.

*When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other which is too taxing for a student to scroll all the way down to read a particular review.

*This bad User Interface design along with very slow view rendering process motivated us to design an elegant interface which is user friendly and well as fast. This prompted us to use JQuery tabs.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.
The implementation of this design involved the separation of the code that ……..

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.
==Code Changes==
:Score for <%= @assignment.name %>

<TABLE class="grades" >
<%= render :partial => 'grades/participant_title', :locals => {:prefix => nil} %>
<%= render :partial => 'grades/participant', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</TABLE>
<BR/>
<a href="javascript:window.history.back()">Back</a>

<TR class="row" id="<%= prefix %>_files" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/submissions', :locals => {:participant => participant} %></TD> </TR>
<TR class="row" id="<%= prefix %>_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD></TR>
<TR class="row" id="<%= prefix %>_mreviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/metareviews', :locals => {:prefix => prefix, :participant => participant, :rscore => pscore[:metareview]} %></TD></TR>
<TR class="row" id="<%= prefix %>_teammate_reviews" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/teammate_reviews', :locals => {:prefix =>prefix, :participant => participant, :rscore => pscore[:teammate]} %></TD></TR>
<TR class="row" id="<%= prefix %>_feedback" style="display:none"><TD COLSPAN="9"><%= render :partial=>'grades/author_feedbacks', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:feedback]} %></TD></TR>

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with E804 which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T01:49:32Z

Knjhaver: /* Testing the new User Interface */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.
The implementation of this design involved the separation of the code that ……..

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.
==Code Changes==
:Score for <%= @assignment.name %>

<TABLE class="grades" >
<%= render :partial => 'grades/participant_title', :locals => {:prefix => nil} %>
<%= render :partial => 'grades/participant', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</TABLE>
<BR/>
<a href="javascript:window.history.back()">Back</a>

</TR>
<TR class="row" id="<%= prefix %>_files" style="display:none">
<TD COLSPAN="9"><%= render :partial=>'grades/submissions', :locals => {:participant => participant} %></TD>
</TR>
<TR class="row" id="<%= prefix %>_reviews" style="display:none">
<TD COLSPAN="9"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
</TR>
<TR class="row" id="<%= prefix %>_mreviews" style="display:none">
<TD COLSPAN="9"><%= render :partial=>'grades/metareviews', :locals => {:prefix => prefix, :participant => participant, :rscore => pscore[:metareview]} %> </TD>
</TR>
<TR class="row" id="<%= prefix %>_feedback" style="display:none">
<TD COLSPAN="9"><%= render :partial=>'grades/author_feedbacks', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:feedback]} %>
</TD>
</TR>
<TR class="row" id="<%= prefix %>_teammate_reviews" style="display:none">
<TD COLSPAN="9"><%= render :partial=>'grades/teammate_reviews', :locals => {:prefix => prefix, :participant => participant, :rscore => pscore[:teammate]} %>
</TD>
</TR>

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber<ref name="cucumber">''Cucumber'' Retrieved from https://github.com/cucumber/cucumber-rails</ref> is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with E804 which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T01:44:34Z

Knjhaver: /* Future Work */

== Introduction ==
Expertiza<ref name="expertiza>''Expertiza'' Retrieved from http://wikis.lib.ncsu.edu/index.php/Expertiza</ref> 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. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

Classes: grades_controller.rb (241 lines), and probably other classes used by this
What it does: This class is responsible for displaying grades to students (via view_my_scores) and
instructors (via the view method).

===What needs to be done:===
* 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. This project deals with the second of these concerns.

* Move as much html as possible from the controllers into the views. Logic should be handled by
the controllers/models, and the views should simply access those variables set by the controller.
HTML should be in html.erb files, not written by controller files.

* Rather than write HTML for displaying all of the reviews on a single page, only the summary
information for each student and team should be written. This should work more like the Review
Report that an instructor can view (see review_mapping_controller.rb). This shows each review
in a popup when the user clicks on a particular review. You don’t need to use a popup; the
review could be populated on the current page when a user clicks on “Show reviews”.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.
The implementation of this design involved the separation of the code that ……..

==Initial User Interface to view scores==
Previously,the view_my_scores html.erb page displayed all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and thus makes the view rendering a slow process. Also it’s a very bad user interface
design.

When a user clicks on show reviews/metareviews,etc the reviews gets rendered below each other

==Modified User Interface to view scores and reviews in tabs==

The new user interface separates the code into various tabs for reporting the scores and also a tab format for displaying reviews.
==Code Changes==
:Score for <%= @assignment.name %>

<TABLE class="grades" >
<%= render :partial => 'grades/participant_title', :locals => {:prefix => nil} %>
<%= render :partial => 'grades/participant', :locals => {:prefix => 'user', :team => false, :pscore => @participant.get_scores(@questions)} %>
</TABLE>
<BR/>
<a href="javascript:window.history.back()">Back</a>

</TR>
<TR class="row" id="<%= prefix %>_files" style="display:none">
<TD COLSPAN="9"><%= render :partial=>'grades/submissions', :locals => {:participant => participant} %></TD>
</TR>
<TR class="row" id="<%= prefix %>_reviews" style="display:none">
<TD COLSPAN="9"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
</TR>
<TR class="row" id="<%= prefix %>_mreviews" style="display:none">
<TD COLSPAN="9"><%= render :partial=>'grades/metareviews', :locals => {:prefix => prefix, :participant => participant, :rscore => pscore[:metareview]} %> </TD>
</TR>
<TR class="row" id="<%= prefix %>_feedback" style="display:none">
<TD COLSPAN="9"><%= render :partial=>'grades/author_feedbacks', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:feedback]} %> </TD>
</TR>
<TR class="row" id="<%= prefix %>_teammate_reviews" style="display:none">
<TD COLSPAN="9"><%= render :partial=>'grades/teammate_reviews', :locals => {:prefix => prefix, :participant => participant, :rscore => pscore[:teammate]} %> </TD>
</TR>

==Testing the new User Interface==
Rails makes it super easy to write your tests. It starts by producing skeleton test code while you are creating your models and controllers. By simply running your Rails tests you can ensure your code adheres to the desired functionality even after some major code refactoring. Rails tests can also simulate browser requests and thus you can test your application's response without having to test it through your browser.

===Testing with Cucumber===
Cucumber is a high-level testing framework. It is used commonly to perform various integration tests. We used Cucumber to test our new tabbed user interface. Cucumber is used extensively in Expertiza. It constitutes some of the main test cases. All cucumber test scenarios are under Features.

===View My Score Test===
To test the improved user interface, we had to modify already existing test scenario with the following modifications.

Feature: View scores for an assignment
In order to view resulting scores
As a student

@wip
Scenario: View my submitted work scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a work review with score of "85"
And I have a work review with score of "66"
And I have a work review with score of "99"
When I click the "show reviews" link
Then I should see the three reviews for my submitted work with corresponding scores

@wip
Scenario: View my author feedback scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a feedback review with score of "93"
When I click the "show author feedbacks" link
Then I should see the author feedback review with corresponding score

@wip
Scenario: View my teammate review scores
Given I am logged in as a student
And I move to the "Assignments" page
And I click the "test_Metareview" link
And I click the "Your scores" link
And I have a teammate review with score of "100"
And I have a teammate review with score of "100"
When I click the "show teammate reviews" link
Then I should see the two teammate reviews with corresponding scores

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page. Hence to make views faster, models and methods should be re-factored too.

* Merge this project with E804 which deals with an efficient way to query DB models to return scores,without UI changes. This will make the review rendering process fast.
* View_my_Score method in the controller saves the questionnaire in a hashmap. It needs re-factoring to make it optimal.
* Total score tab needs to be displayed either to the right or left or remaining tabs.

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T01:37:40Z

Knjhaver:

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T01:37:21Z

Knjhaver: /* Testing */

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T01:05:31Z

Knjhaver:

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T01:02:17Z

Knjhaver:

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T01:00:11Z

Knjhaver:

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T00:58:50Z

Knjhaver: /* Introduction */

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T00:54:35Z

Knjhaver: /* References */

== 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. It is an open source project developed on Ruby on Rails platform. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. The source code can be forked and cloned for making modifications.

This wiki provides an insight into our contributions to the Open Source Software project Expertiza with main focus on the UI changes for reporting scores. Reporting score functionality is handled by controllers/grades_controller.rb and rendered by views/grades/_view_my_score.html.erb. Improved User Interface using JQuery is our contribution to Expertiza. This new elegant UI uses tabs instead of tables which makes it look elegant and renders faster. Subtle code and design challenges, changes and the motivation to implement this design have been explained further.

== Project Description ==
The view_my_scores html.erb page is being slow-rendered. The page displays all the scores in a tabular form with reviews, metareviews, author feedback below each other. Everything is merged into one big html page, and this makes the view rendering a slow process. Also, the user interface is not aesthetically pleasing. The challenge here is to make appropriate changes to the views so that the rendering time becomes less as well as to improve the over-all look and feel of the score report page.

== Design ==
We have implemented partial rendering for the HTML page. The tabs are created using JQuery. The advantage of using JQuery is that it enables a sleeker and cleaner interface on pages without requiring the page to be loaded all at once. The new view page is visually aesthetic as it separates the scoring tabs as well as the review tabs and each review is rendered only when the tab for that review is clicked on. Thereby this approach overcomes the previous issue of the entire page being rendered at once.
The implementation of this design involved the separation of the code that ……..

==Initial Design==
==Changes in the UI after the implementation==

==Future Work==
In the current implementation of the model separate DB queries are made sequentially while the HTML page is being written. This increases the loading time of the page.The implementation would get a further performance boost if the underlying DB queries are fired independent of the….

==Appendix==
Set-Up issues:

==Testing==

==References==
<references/>

CSC/ECE 517 Fall 2013/oss E805 kkn

2013-10-31T00:50:16Z

Knjhaver: Created page with "== 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 ..."

CSC/ECE 517 Fall 2013

2013-10-31T00:07:28Z

Knjhaver:

* [[ CSC/ECE 517 Fall 2012/ch1 1w23 ph ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w30 nn]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w21 w]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w01 aj]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w24 nv]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w29 rkld]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w25 aras]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w30 ps]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w19 rj]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w18 bs]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w17 pk]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w22 ss]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w12 vn]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w14 st]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w08 cc]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w10 ga ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w26 as ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w27 ma ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w13 aa ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w11 sv ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w07 d ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w20 gq ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w03 ss ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w28 nm ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w02 pp ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w6 zs ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w04 y ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w05 st ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w09 hs ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w32 av ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w48 x ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w43 av]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w46 ka]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w33 aa]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w35 sa ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w39 as ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w31 vm ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w43 sm ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w44 s ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w47 ka ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w34 fs ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w40 ao ]]
* [[ CSC/ECE 517 Fall 2013/oss fmv ]]
* [[ CSC/ECE 517 Fall 2013/oss vna ]]
* [[ CSC/ECE 517 Fall 2013/oss paa ]]
* [[ CSC/ECE 517 Fall 2013/oss mapFeeds ]]
* [[ CSC/ECE 517 Fall 2013/oss ssp ]]
* [[ CSC/ECE 517 Fall 2013/ch2 0e808 nsv ]]
* [[ CSC/ECE 517 Fall 2013/oss aoa ]]
* [[ CSC/ECE 517 Fall 2013/oss cmh ]]
* [[ CSC/ECE 517 Fall 2013/oss ans ]]
* [[ CSC/ECE 517 Fall 2013/oss ssv]]
* [[ CSC/ECE 517 Fall 2013/oss E818 mra ]]
* [[ CSC/ECE 517 Fall 2013/oss SocialMediaFeeds ]]
* [[ CSC/ECE 517 Fall 2013/oss E811 syn ]]
* [[ CSC/ECE 517 Fall 2013/oss E804 spb ]]
* [[ CSC/ECE 517 Fall 2013/oss E812 amp ]]
* [[ CSC/ECE 517 Fall 2013/oss S805 ahs ]]
* [[ CSC/ECE 517 Fall 2013/oss E820 gzs ]]
* [[ CSC/ECE 517 Fall 2013/oss E816 cyy ]]
* [[ CSC/ECE 517 Fall 2013/oss M801 as ]]
* [[ CSC/ECE 517 Fall 2013/oss E814 vd ]]
* [[ CSC/ECE 517 Fall 2013/oss E815 saa]]
* [[ CSC/ECE 517 Fall 2013/oss E810 aas ]]
* [[ CSC/ECE 517 Fall 2013/oss E805 kkn ]]

CSC/ECE 517 Fall 2013/ch1 1w46 ka

2013-10-08T00:36:53Z

Knjhaver:

''' Data Mining in Rails Application'''

This wiki discusses the implementation of Data Mining tasks i.e automatic or semi-automatic analysis of large quantities of data to extract previously unknown interesting patterns such as groups of data records, unusual records and dependencies in Rails Application.

== Introduction to Data Mining in Rails Application ==

Data mining <ref name="mining> Usama Fayyad, Gregory Piatetsky-Shapiro and Padhraic Smyth. (2008, Dec 17). ''From Data Mining to Knowledge Discoveries in Databases.'' Retrieved from http://www.kdnuggets.com/gpspubs/aimag-kdd-overview-1996-Fayyad.pdf</ref> (the analysis step of the "Knowledge Discovery in Databases" process, or KDD) is the computational process of discovering patterns in large data sets involving methods at the intersection of artificial intelligence, machine learning, statistics, and database systems. The overall goal of the data mining process is to extract information from a data set and transform it into an understandable structure for further use.

Ruby on Rails, often simply Rails, is an open source web application framework which runs on the Ruby programming language. Data mining techniques like <code> [http://en.wikipedia.org/wiki/K-means_clustering K-means clustering] </code> can be developed on ruby on rails by using various gems which ruby provides.
Thus it becomes easier for a data mining analyst to write mining code in a ruby on rails application.

==Weka and Ruby==

<code>[http://www.cs.waikato.ac.nz/ml/weka/ Weka]</code> is a collection of <code>[http://en.wikipedia.org/wiki/Machine_learning machine learning]</code> algorithms for data mining tasks. The algorithms can either be applied directly to a dataset or called from an embedded code. Weka contains tools for data pre-processing, classification, regression, clustering, association rules, and visualization.[http://www.ibm.com/developerworks/library/ba-data-mining-techniques/] It is also well-suited for developing new machine learning schemes. Weka is written in Java however it is possible to use Weka’s libraries inside Ruby. To do this, we must install Java, <code>[http://rubygems.org/gems/rjb Rjb]</code>, and of course obtain the Weka source code. We use <code>[https://github.com/jruby/jruby/wiki/AboutJRuby JRuby]</code> and this is illustrated as follows: <ref name="wekaruby">Peter Lane. (2009, Aug 15). ''Accessing Weka with JRuby.'' Retrieved from http://rubyforscientificresearch.blogspot.com/2009/08/accessing-weka-from-jruby.html</ref>

===Clustering Data using WEKA from JRuby===

JRuby provides easy access to Java classes and methods, and WEKA is no exception. The following program builds a simple k-means cluster on a supplied input file, and then prints out the assigned cluster for each data instance. The 'include_class' statements are there to simplify references to classes in the API. When classifying each instance, we must watch for the exception thrown in case a classification cannot be made. Finally, notice that the filename is passed as a command-line parameter: the parameters after the name of the JRuby program are packaged up into ARGV in the usual ruby style. Assuming weka.jar, jruby.jar, and your program are in the same folder, a sample Ruby example is shown bellow:

# Weka scripting from jruby
require "java"
require "weka"
include_class "java.io.FileReader"
include_class "weka.clusterers.SimpleKMeans"
include_class "weka.core.Instances"

# load data file
file = FileReader.new ARGV[0]
data = Instances.new file

# create the model
kmeans = SimpleKMeans.new
kmeans.buildClusterer data

# print out the built model
print kmeans

# Display the cluster for each instance
data.numInstances.times do |i|
cluster = "UNKNOWN"
begin
cluster = kmeans.clusterInstance(data.instance(i))
rescue java.lang.Exception
end
puts "#{data.instance(i)},#{cluster}"
end

We can see that the WEKA API makes it easy to pass in a data file. Data can be in a number of formats, including <code>[http://www.cs.waikato.ac.nz/ml/weka/arff.html ARFF]</code> and <code>[http://docs.python.org/2/library/csv.html CSV]</code>. When run on the weather.arff example (in WEKA's 'data' folder), the output looks like the following:

Number of iterations: 3
Within cluster sum of squared errors: 16.237456311387238
Missing values globally replaced with mean/mode

Cluster centroids:
Cluster#
Attribute Full Data 0 1
(14) (9) (5)

outlook sunny sunny overcast
temperature 73.5714 75.8889 69.4
humidity 81.6429 84.1111 77.2
windy FALSE FALSE TRUE
play yes yes yes

===Advantages of using Weka from jRuby===

One of the advantages of using a language like jruby to talk to WEKA is that we should have more control on how our data is constructed and passed to the machine-learning algorithms. A good start is how to construct our own set of instances, rather than reading them directly in from file. There are some quirks to WEKA's construction of a set of instances. In particular, each attribute must be defined through an instance of the Attribute class. This class gives a string name to the attribute and if the attribute is a nominal attribute, the class also holds a vector of the nominal values. Each instance can then be constructed and added to the growing set of instances.

==Popular gems for Data Mining==

Since data mining is a complex process of retrieving data from a huge set of databases, many gems are used to ease this procedure in a rails application. Some of the popular gems are RVol, Rbbt and RubyBand. They are explained below.

===RVol===

Gem for creating a database for data mining stock markets focusing on <code> [http://www.spindices.com/indices/equity/sp-500 SP500]</code> data. Rvol enables investors to study market volatility from free data on the internet. RVol is the most popular gem for data mining applications developed in Rails. The created database could be used for instance from <code>[https://www.stat.auckland.ac.nz/~ihaka/downloads/Interface98.pdf R] </code> or <code> [http://www.altiusdirectory.com/Computers/matlab-programming-language.php Matlab]</code> or similar to do quantitative analysis. You could script new data mining functions extending the Rvol library, load the data into a statistics package, or use it with your own quantitative framework. Usage: rvol -s will create the database. The database contains stocks (with industries), options, implied volatility and calculated standard deviations for the day. Earnings are downloaded and listed with implied volatilities for front and back month options. There are some reports, which can be generated after the database is downloaded by looking at rvol -p. There is a function to calculate correlations between stocks in the same industry groups (--correlationAll, --correlation10 (10 day correlation),this will take a long time and jruby is recommended for a better use of system resources. Rvol downloads option chains, calculates implied volatilities for them and has features to list top 10 type of lists for potential investment opportunities. 'Put' call ratios are calculated , total amount of 'puts' or 'calls' for a particular company etc are available. These can be used to measure the market sentiment. Different filters can be used to find stocks/options with high volatilities, stocks with high options volume for the day etc which are indicators of forthcoming events. <ref name="rvol">Toni Karhu. (2012, Aug 18). ''The Ruby ToolBox: RVol.'' Retrieved from https://www.ruby-toolbox.com/projects/rvol</ref>

====Installation of RVol====

Since RVol is a Ruby Gem, we must install it by including it in the Gem file of our Rails application. Version 0.6.4 is the latest and the most stable version by Tonic.

gem install rvol -v 0.6.4

====Example: Use of RVol to Generate stock market databases====

RVol is commonly used to populate databases for Mining stock market data. A sample code snippet below shows the simple way to generate a test database from internet data. <ref name="rvolEg">Toni Karhu. (2012, Aug 19). ''A ruby gem for downloading and processing options chains and financial data.'' Retrieved from https://github.com/tonik/rvol</ref>

require 'Rvol'
require 'test/unit'
require 'dm-core'
require 'dm-migrations'
require 'model/stock'
require 'model/chain'
require 'model/earning'
require 'model/stockcorrelation'

#set the test db an in memory db
DataMapper::Logger.new($stdout, :debug)

puts File.dirname(__FILE__)

DataMapper.setup(:default, "sqlite::memory:")
DataMapper.finalize
DataMapper.auto_migrate!

# GENERATE THE TEST DATABASE FROM INTERNET DATA

puts 'GENERATING TEST DATABASE AND TESTING SCRAPERS'

end

===Rbbt===

Rbbt stands for Ruby Bio-Text, it started as an API for <code> [http://people.ischool.berkeley.edu/~hearst/text-mining.html text mining] </code> developed for <code> [http://sent.dacya.ucm.es/ SENT] </code>, but its functionality has been used for other applications as well, such as <code> [http://marq.dacya.ucm.es/ MARQ] </code>. Rbbt covers several functionalities, some will work right away, some require to install dependencies or download and process data from the internet. Since not all users are likely to need all the functionalities, the dependencies of this gem include only the very basic requirements. Dependencies may appear unexpectedly when using new parts of the API. <ref name="rbbt">Miguel Vazquez. (2013, June 10). ''Rbbt.'' Retrieved from http://rubydoc.info/gems/rbbt/frames</ref>

====Installation of Rbbt====

Install the gem normally gem install rbbt. The gem includes a configuration tool rbbt_config. The first time you run it, it will ask you to configure some paths. After that you may use it to process the data for different tasks.

====Example: Use of Rbbt to translate identifiers====

1. Do rbbt_config prepare identifiers to do deploy the configuration files and enter 'gene' data, this needs to be done just once.

2. Now you may do rbbt_config install 'organisms' to process all the 'organisms', or rbbt_config install organisms such as 'yeast'.

3. You may now use a script like this to translate 'gene' identifiers from 'yeast' feed from the standard input.

require 'rbbt/sources/organism'

index = Organism.id_index('Sce', :native => 'Enter Gene Id')

STDIN.each_line{|l| puts "#{l.chomp} => #{index[l.chomp]}"}

===Ruby Band===

Ruby Band is a Ruby Gem that makes use of some selected Java software for data mining and machine learning applications available to the JRuby/Ruby users. Ruby Band features a comprehensive collection of data preprocessing and modeling techniques, and supports several standard data mining tasks, more specifically: data pre-processing (filtering), clustering, classification, regression, and <code> [http://jmlr.org/papers/v3/guyon03a.html feature selection] </code>. <ref name="rubyband">Alberto Arrigoni. (2013, Sept 24). ''Data Mining in JRuby with Ruby Band.'' Retrieved from http://sciruby.com/blog/2013/09/24/gsoc-2013-data-mining-in-jruby-with-ruby-band</ref>

====Installation of Ruby Band====

Install the 'jbundle' gem and 'bundle' for JRuby before trying to install the 'ruby-band' gem.

If you want to use 'ruby-band' APIs without installing the gem you need to run command 'rake -T' once before requiring the gem in your script (this is necessary for jbundler to download the '.jar' files and subsequently set the Java classpath). Otherwise use:

gem install ruby-band

====Example: Use of Ruby Band for Data Parsing====

One central datatype of ruby-band is derived from the Weka counterpart (the class Weka.core.Instances). By instantiating this class, we obtain a matrix-like structure for storing an entire dataset. Ad-hoc methods were created to guarantee that 'Instances' class objects can be converted to other datatypes (e.g. Apache matrix) and back. There are currently many ways to import data into ruby-band. But the basic way is to Parse data from ARFF/CSV files. <ref name="rubybandGit">Alberto Arrigoni. (2013, Sept 23). ''Ruby-Band Examples.'' Retrieved from https://github.com/arrigonialberto86/ruby-band</ref>

You can simply parse an external Weka ARFF/CSV file by doing:

require 'ruby-band'
dataset = Core::Parser.parse_ARFF(my_file.arff)
dataset = Core::Parser.parse_CSV(my_file.csv)

====Example: Use of Ruby Band for Data Classification====

Classification and regression algorithms in WEKA are called “classifiers” and are located below the Weka::Classifier:: module. Currently, ruby-band only supports batch-trainable classifiers: this means they get trained on the whole dataset at once. Below is a quick example of how to train a classifier on a dataset parsed from an '''<code>[http://www.cs.waikato.ac.nz/ml/weka/arff.html ARFF]</code>'''(attribute relation file format). <ref name="rubybandGit">Alberto Arrigoni. (2013, Sept 23). ''Ruby-Band Examples.'' Retrieved from https://github.com/arrigonialberto86/ruby-band</ref>

require 'ruby-band'

# parse a dataset
dataset = Core::Parser.parse_ARFF(my_file.arff)

# initialize and train a classifier
classifier = Weka::Classifier::Lazy::KStar::Base.new do
set_options '-M d'
set_data dataset
set_class_index 4
end

# cross-validate the trained classifier
puts classifier.cross_validate(3)

====Example: Use of Ruby Band for Data Clustering====

Clustering is an unsupervised Machine Learning technique of finding patterns in the data, i.e., these algorithms work without class attributes. Classifiers, on the other hand, are supervised and need a class attribute. This section, similar to the one about classifiers, covers the following topics:
* Building a clusterer - batch (incremental must still be implemented) learning.
* Evaluating a clusterer - how to evaluate a built clusterer.
* Clustering instances - determining what clusters unknown instances belong to. <ref name="rubybandGit">Alberto Arrigoni. (2013, Sept 23). ''Ruby-Band Examples.'' Retrieved from https://github.com/arrigonialberto86/ruby-band</ref>

==Data Mining with Ruby and Twitter==

The following sections present a few scripts for collecting and presenting data available through the Twitter API. These scripts focus on simplicity, but you can extend and combine them to create new capabilities. <ref name="TwitterData">M. Tim Jones. (2011, Oct 11). ''Data Mining with Ruby and Twitter.'' Retrieved from http://www.ibm.com/developerworks/library/os-dataminingrubytwitter/os-dataminingrubytwitter-pdf.pdf</ref>

===Twitter User Information===

A large amount of information is available about each Twitter user. This information is only accessible if the user isn't protected. Let's look at how you can extract a user's data and present it in a more convenient way. Listing below presents a simple Ruby script to retrieve a user's information (based on his or her screen name), and then emit some of the more useful elements. You use the 'to_s' Ruby method to convert the value to a string as needed. Note that you first ensure that the user isn't protected; otherwise, this data wouldn't be accessible.

#!/usr/bin/env ruby
require "rubygems"
require "twitter"

screen_name = String.new ARGV[0]

a_user = Twitter.user(screen_name)

if a_user.protected != true

puts "Username : " + a_user.screen_name.to_s
puts "Name : " + a_user.name
puts "Id : " + a_user.id_str
puts "Location : " + a_user.location
puts "User since : " + a_user.created_at.to_s
puts "Bio : " + a_user.description.to_s
puts "Followers : " + a_user.followers_count.to_s
puts "Friends : " + a_user.friends_count.to_s
puts "Listed Cnt : " + a_user.listed_count.to_s
puts "Tweet Cnt : " + a_user.statuses_count.to_s
puts "Geocoded : " + a_user.geo_enabled.to_s
puts "Language : " + a_user.lang
if (a_user.url != nil)
puts "URL : " + a_user.url.to_s
end
if (a_user.time_zone != nil)
puts "Time Zone : " + a_user.time_zone
end
puts "Verified : " + a_user.verified.to_s
puts

tweet = Twitter.user_timeline(screen_name).first

puts "Tweet time : " + tweet.created_at
puts "Tweet ID : " + tweet.id.to_s
puts "Tweet text : " + tweet.text

end

===Twitter User Behavior===

Twitter contains a large amount of data that you can mine to understand some elements of user behavior. Two simple examples are to analyze when a Twitter user tweets and from what application the user tweets. You can use the following two simple scripts to extract and visualize this information. Listing below presents a script that iterates the tweets from a particular user (using the user_timeline method), and then for each tweet, extracts the particular day on which the tweet originated. You use a simple hash again to accumulate your weekday counts, then generate a bar chart using Google Charts in a similar fashion to the previous time zone example. Note also the use of default for the hash, which specifies the value to return for undefined hashes.

#!/usr/bin/env ruby
require "rubygems"
require "twitter"
require "google_chart"

screen_name = String.new ARGV[0]

dayhash = Hash.new

# Initialize to avoid a nil error with GoogleCharts (undefined is zero)
dayhash.default = 0

timeline = Twitter.user_timeline(screen_name, :count => 200 )
timeline.each do |t|

tweetday = t.created_at.to_s[0..2]

if dayhash.has_key?(tweetday)
dayhash[tweetday] = dayhash[tweetday] + 1
else
dayhash[tweetday] = 1
end

end

We need to retrieve a BarChart to display per day tweet activity.

GoogleChart::BarChart.new('300x200', screen_name, :vertical, false) do |bc|
bc.data "Sunday", [dayhash["Sun"]], '00000f'
bc.data "Monday", [dayhash["Mon"]], '0000ff'
bc.data "Tuesday", [dayhash["Tue"]], '00ff00'
bc.data "Wednesday", [dayhash["Wed"]], '00ffff'
bc.data "Thursday", [dayhash["Thu"]], 'ff0000'
bc.data "Friday", [dayhash["Fri"]], 'ff00ff'
bc.data "Saturday", [dayhash["Sat"]], 'ffff00'
puts bc.to_url
end

[[File:img2333.jpg]]

Running the above mining script provides the result of the execution of the tweet-days script in the above Listing for the developerWorks account. As shown, Wednesday tends to be the most active tweet day, with Saturday and Sunday the least active.

==References==

<references/>

==Further Reading==
# Rudi Cilibrasi(2008,Oct 4)''CompLearn: A compression-based data-mining toolkit.'' Retrieved from http://www.ruby-doc.org/gems/docs/c/complearn-0.6.2/doc/readme_txt.html

# Seamus Abshere and Andy Rossmeissl (2012, May 14) Real time example of Data Mining Rails Example.[http://impact.brighterplanet.com/] Retrieved from http://www.rubydoc.info/gems/data_miner-ruby19/frames

CSC/ECE 517 Fall 2013/ch1 1w46 ka

2013-10-08T00:35:39Z

Knjhaver:

CSC/ECE 517 Fall 2013/ch1 1w46 ka

2013-10-08T00:35:22Z

Knjhaver:

''' Data Mining in Rails Application'''
This wiki discusses the implementation of Data Mining tasks i.e automatic or semi-automatic analysis of large quantities of data to extract previously unknown interesting patterns such as groups of data records, unusual records and dependencies in Rails Application.

== Introduction to Data Mining in Rails Application ==

Data mining <ref name="mining> Usama Fayyad, Gregory Piatetsky-Shapiro and Padhraic Smyth. (2008, Dec 17). ''From Data Mining to Knowledge Discoveries in Databases.'' Retrieved from http://www.kdnuggets.com/gpspubs/aimag-kdd-overview-1996-Fayyad.pdf</ref> (the analysis step of the "Knowledge Discovery in Databases" process, or KDD) is the computational process of discovering patterns in large data sets involving methods at the intersection of artificial intelligence, machine learning, statistics, and database systems. The overall goal of the data mining process is to extract information from a data set and transform it into an understandable structure for further use.

Ruby on Rails, often simply Rails, is an open source web application framework which runs on the Ruby programming language. Data mining techniques like <code> [http://en.wikipedia.org/wiki/K-means_clustering K-means clustering] </code> can be developed on ruby on rails by using various gems which ruby provides.
Thus it becomes easier for a data mining analyst to write mining code in a ruby on rails application.

==Weka and Ruby==

<code>[http://www.cs.waikato.ac.nz/ml/weka/ Weka]</code> is a collection of <code>[http://en.wikipedia.org/wiki/Machine_learning machine learning]</code> algorithms for data mining tasks. The algorithms can either be applied directly to a dataset or called from an embedded code. Weka contains tools for data pre-processing, classification, regression, clustering, association rules, and visualization.[http://www.ibm.com/developerworks/library/ba-data-mining-techniques/] It is also well-suited for developing new machine learning schemes. Weka is written in Java however it is possible to use Weka’s libraries inside Ruby. To do this, we must install Java, <code>[http://rubygems.org/gems/rjb Rjb]</code>, and of course obtain the Weka source code. We use <code>[https://github.com/jruby/jruby/wiki/AboutJRuby JRuby]</code> and this is illustrated as follows: <ref name="wekaruby">Peter Lane. (2009, Aug 15). ''Accessing Weka with JRuby.'' Retrieved from http://rubyforscientificresearch.blogspot.com/2009/08/accessing-weka-from-jruby.html</ref>

===Clustering Data using WEKA from JRuby===

JRuby provides easy access to Java classes and methods, and WEKA is no exception. The following program builds a simple k-means cluster on a supplied input file, and then prints out the assigned cluster for each data instance. The 'include_class' statements are there to simplify references to classes in the API. When classifying each instance, we must watch for the exception thrown in case a classification cannot be made. Finally, notice that the filename is passed as a command-line parameter: the parameters after the name of the JRuby program are packaged up into ARGV in the usual ruby style. Assuming weka.jar, jruby.jar, and your program are in the same folder, a sample Ruby example is shown bellow:

# Weka scripting from jruby
require "java"
require "weka"
include_class "java.io.FileReader"
include_class "weka.clusterers.SimpleKMeans"
include_class "weka.core.Instances"

# load data file
file = FileReader.new ARGV[0]
data = Instances.new file

# create the model
kmeans = SimpleKMeans.new
kmeans.buildClusterer data

# print out the built model
print kmeans

# Display the cluster for each instance
data.numInstances.times do |i|
cluster = "UNKNOWN"
begin
cluster = kmeans.clusterInstance(data.instance(i))
rescue java.lang.Exception
end
puts "#{data.instance(i)},#{cluster}"
end

We can see that the WEKA API makes it easy to pass in a data file. Data can be in a number of formats, including <code>[http://www.cs.waikato.ac.nz/ml/weka/arff.html ARFF]</code> and <code>[http://docs.python.org/2/library/csv.html CSV]</code>. When run on the weather.arff example (in WEKA's 'data' folder), the output looks like the following:

Number of iterations: 3
Within cluster sum of squared errors: 16.237456311387238
Missing values globally replaced with mean/mode

Cluster centroids:
Cluster#
Attribute Full Data 0 1
(14) (9) (5)

outlook sunny sunny overcast
temperature 73.5714 75.8889 69.4
humidity 81.6429 84.1111 77.2
windy FALSE FALSE TRUE
play yes yes yes

===Advantages of using Weka from jRuby===

One of the advantages of using a language like jruby to talk to WEKA is that we should have more control on how our data is constructed and passed to the machine-learning algorithms. A good start is how to construct our own set of instances, rather than reading them directly in from file. There are some quirks to WEKA's construction of a set of instances. In particular, each attribute must be defined through an instance of the Attribute class. This class gives a string name to the attribute and if the attribute is a nominal attribute, the class also holds a vector of the nominal values. Each instance can then be constructed and added to the growing set of instances.

==Popular gems for Data Mining==

Since data mining is a complex process of retrieving data from a huge set of databases, many gems are used to ease this procedure in a rails application. Some of the popular gems are RVol, Rbbt and RubyBand. They are explained below.

===RVol===

Gem for creating a database for data mining stock markets focusing on <code> [http://www.spindices.com/indices/equity/sp-500 SP500]</code> data. Rvol enables investors to study market volatility from free data on the internet. RVol is the most popular gem for data mining applications developed in Rails. The created database could be used for instance from <code>[https://www.stat.auckland.ac.nz/~ihaka/downloads/Interface98.pdf R] </code> or <code> [http://www.altiusdirectory.com/Computers/matlab-programming-language.php Matlab]</code> or similar to do quantitative analysis. You could script new data mining functions extending the Rvol library, load the data into a statistics package, or use it with your own quantitative framework. Usage: rvol -s will create the database. The database contains stocks (with industries), options, implied volatility and calculated standard deviations for the day. Earnings are downloaded and listed with implied volatilities for front and back month options. There are some reports, which can be generated after the database is downloaded by looking at rvol -p. There is a function to calculate correlations between stocks in the same industry groups (--correlationAll, --correlation10 (10 day correlation),this will take a long time and jruby is recommended for a better use of system resources. Rvol downloads option chains, calculates implied volatilities for them and has features to list top 10 type of lists for potential investment opportunities. 'Put' call ratios are calculated , total amount of 'puts' or 'calls' for a particular company etc are available. These can be used to measure the market sentiment. Different filters can be used to find stocks/options with high volatilities, stocks with high options volume for the day etc which are indicators of forthcoming events. <ref name="rvol">Toni Karhu. (2012, Aug 18). ''The Ruby ToolBox: RVol.'' Retrieved from https://www.ruby-toolbox.com/projects/rvol</ref>

====Installation of RVol====

Since RVol is a Ruby Gem, we must install it by including it in the Gem file of our Rails application. Version 0.6.4 is the latest and the most stable version by Tonic.

gem install rvol -v 0.6.4

====Example: Use of RVol to Generate stock market databases====

RVol is commonly used to populate databases for Mining stock market data. A sample code snippet below shows the simple way to generate a test database from internet data. <ref name="rvolEg">Toni Karhu. (2012, Aug 19). ''A ruby gem for downloading and processing options chains and financial data.'' Retrieved from https://github.com/tonik/rvol</ref>

require 'Rvol'
require 'test/unit'
require 'dm-core'
require 'dm-migrations'
require 'model/stock'
require 'model/chain'
require 'model/earning'
require 'model/stockcorrelation'

#set the test db an in memory db
DataMapper::Logger.new($stdout, :debug)

puts File.dirname(__FILE__)

DataMapper.setup(:default, "sqlite::memory:")
DataMapper.finalize
DataMapper.auto_migrate!

# GENERATE THE TEST DATABASE FROM INTERNET DATA

puts 'GENERATING TEST DATABASE AND TESTING SCRAPERS'

end

===Rbbt===

Rbbt stands for Ruby Bio-Text, it started as an API for <code> [http://people.ischool.berkeley.edu/~hearst/text-mining.html text mining] </code> developed for <code> [http://sent.dacya.ucm.es/ SENT] </code>, but its functionality has been used for other applications as well, such as <code> [http://marq.dacya.ucm.es/ MARQ] </code>. Rbbt covers several functionalities, some will work right away, some require to install dependencies or download and process data from the internet. Since not all users are likely to need all the functionalities, the dependencies of this gem include only the very basic requirements. Dependencies may appear unexpectedly when using new parts of the API. <ref name="rbbt">Miguel Vazquez. (2013, June 10). ''Rbbt.'' Retrieved from http://rubydoc.info/gems/rbbt/frames</ref>

====Installation of Rbbt====

Install the gem normally gem install rbbt. The gem includes a configuration tool rbbt_config. The first time you run it, it will ask you to configure some paths. After that you may use it to process the data for different tasks.

====Example: Use of Rbbt to translate identifiers====

1. Do rbbt_config prepare identifiers to do deploy the configuration files and enter 'gene' data, this needs to be done just once.

2. Now you may do rbbt_config install 'organisms' to process all the 'organisms', or rbbt_config install organisms such as 'yeast'.

3. You may now use a script like this to translate 'gene' identifiers from 'yeast' feed from the standard input.

require 'rbbt/sources/organism'

index = Organism.id_index('Sce', :native => 'Enter Gene Id')

STDIN.each_line{|l| puts "#{l.chomp} => #{index[l.chomp]}"}

===Ruby Band===

Ruby Band is a Ruby Gem that makes use of some selected Java software for data mining and machine learning applications available to the JRuby/Ruby users. Ruby Band features a comprehensive collection of data preprocessing and modeling techniques, and supports several standard data mining tasks, more specifically: data pre-processing (filtering), clustering, classification, regression, and <code> [http://jmlr.org/papers/v3/guyon03a.html feature selection] </code>. <ref name="rubyband">Alberto Arrigoni. (2013, Sept 24). ''Data Mining in JRuby with Ruby Band.'' Retrieved from http://sciruby.com/blog/2013/09/24/gsoc-2013-data-mining-in-jruby-with-ruby-band</ref>

====Installation of Ruby Band====

Install the 'jbundle' gem and 'bundle' for JRuby before trying to install the 'ruby-band' gem.

If you want to use 'ruby-band' APIs without installing the gem you need to run command 'rake -T' once before requiring the gem in your script (this is necessary for jbundler to download the '.jar' files and subsequently set the Java classpath). Otherwise use:

gem install ruby-band

====Example: Use of Ruby Band for Data Parsing====

One central datatype of ruby-band is derived from the Weka counterpart (the class Weka.core.Instances). By instantiating this class, we obtain a matrix-like structure for storing an entire dataset. Ad-hoc methods were created to guarantee that 'Instances' class objects can be converted to other datatypes (e.g. Apache matrix) and back. There are currently many ways to import data into ruby-band. But the basic way is to Parse data from ARFF/CSV files. <ref name="rubybandGit">Alberto Arrigoni. (2013, Sept 23). ''Ruby-Band Examples.'' Retrieved from https://github.com/arrigonialberto86/ruby-band</ref>

You can simply parse an external Weka ARFF/CSV file by doing:

require 'ruby-band'
dataset = Core::Parser.parse_ARFF(my_file.arff)
dataset = Core::Parser.parse_CSV(my_file.csv)

====Example: Use of Ruby Band for Data Classification====

Classification and regression algorithms in WEKA are called “classifiers” and are located below the Weka::Classifier:: module. Currently, ruby-band only supports batch-trainable classifiers: this means they get trained on the whole dataset at once. Below is a quick example of how to train a classifier on a dataset parsed from an '''<code>[http://www.cs.waikato.ac.nz/ml/weka/arff.html ARFF]</code>'''(attribute relation file format). <ref name="rubybandGit">Alberto Arrigoni. (2013, Sept 23). ''Ruby-Band Examples.'' Retrieved from https://github.com/arrigonialberto86/ruby-band</ref>

require 'ruby-band'

# parse a dataset
dataset = Core::Parser.parse_ARFF(my_file.arff)

# initialize and train a classifier
classifier = Weka::Classifier::Lazy::KStar::Base.new do
set_options '-M d'
set_data dataset
set_class_index 4
end

# cross-validate the trained classifier
puts classifier.cross_validate(3)

====Example: Use of Ruby Band for Data Clustering====

Clustering is an unsupervised Machine Learning technique of finding patterns in the data, i.e., these algorithms work without class attributes. Classifiers, on the other hand, are supervised and need a class attribute. This section, similar to the one about classifiers, covers the following topics:
* Building a clusterer - batch (incremental must still be implemented) learning.
* Evaluating a clusterer - how to evaluate a built clusterer.
* Clustering instances - determining what clusters unknown instances belong to. <ref name="rubybandGit">Alberto Arrigoni. (2013, Sept 23). ''Ruby-Band Examples.'' Retrieved from https://github.com/arrigonialberto86/ruby-band</ref>

==Data Mining with Ruby and Twitter==

The following sections present a few scripts for collecting and presenting data available through the Twitter API. These scripts focus on simplicity, but you can extend and combine them to create new capabilities. <ref name="TwitterData">M. Tim Jones. (2011, Oct 11). ''Data Mining with Ruby and Twitter.'' Retrieved from http://www.ibm.com/developerworks/library/os-dataminingrubytwitter/os-dataminingrubytwitter-pdf.pdf</ref>

===Twitter User Information===

A large amount of information is available about each Twitter user. This information is only accessible if the user isn't protected. Let's look at how you can extract a user's data and present it in a more convenient way. Listing below presents a simple Ruby script to retrieve a user's information (based on his or her screen name), and then emit some of the more useful elements. You use the 'to_s' Ruby method to convert the value to a string as needed. Note that you first ensure that the user isn't protected; otherwise, this data wouldn't be accessible.

#!/usr/bin/env ruby
require "rubygems"
require "twitter"

screen_name = String.new ARGV[0]

a_user = Twitter.user(screen_name)

if a_user.protected != true

puts "Username : " + a_user.screen_name.to_s
puts "Name : " + a_user.name
puts "Id : " + a_user.id_str
puts "Location : " + a_user.location
puts "User since : " + a_user.created_at.to_s
puts "Bio : " + a_user.description.to_s
puts "Followers : " + a_user.followers_count.to_s
puts "Friends : " + a_user.friends_count.to_s
puts "Listed Cnt : " + a_user.listed_count.to_s
puts "Tweet Cnt : " + a_user.statuses_count.to_s
puts "Geocoded : " + a_user.geo_enabled.to_s
puts "Language : " + a_user.lang
if (a_user.url != nil)
puts "URL : " + a_user.url.to_s
end
if (a_user.time_zone != nil)
puts "Time Zone : " + a_user.time_zone
end
puts "Verified : " + a_user.verified.to_s
puts

tweet = Twitter.user_timeline(screen_name).first

puts "Tweet time : " + tweet.created_at
puts "Tweet ID : " + tweet.id.to_s
puts "Tweet text : " + tweet.text

end

===Twitter User Behavior===

Twitter contains a large amount of data that you can mine to understand some elements of user behavior. Two simple examples are to analyze when a Twitter user tweets and from what application the user tweets. You can use the following two simple scripts to extract and visualize this information. Listing below presents a script that iterates the tweets from a particular user (using the user_timeline method), and then for each tweet, extracts the particular day on which the tweet originated. You use a simple hash again to accumulate your weekday counts, then generate a bar chart using Google Charts in a similar fashion to the previous time zone example. Note also the use of default for the hash, which specifies the value to return for undefined hashes.

#!/usr/bin/env ruby
require "rubygems"
require "twitter"
require "google_chart"

screen_name = String.new ARGV[0]

dayhash = Hash.new

# Initialize to avoid a nil error with GoogleCharts (undefined is zero)
dayhash.default = 0

timeline = Twitter.user_timeline(screen_name, :count => 200 )
timeline.each do |t|

tweetday = t.created_at.to_s[0..2]

if dayhash.has_key?(tweetday)
dayhash[tweetday] = dayhash[tweetday] + 1
else
dayhash[tweetday] = 1
end

end

We need to retrieve a BarChart to display per day tweet activity.

GoogleChart::BarChart.new('300x200', screen_name, :vertical, false) do |bc|
bc.data "Sunday", [dayhash["Sun"]], '00000f'
bc.data "Monday", [dayhash["Mon"]], '0000ff'
bc.data "Tuesday", [dayhash["Tue"]], '00ff00'
bc.data "Wednesday", [dayhash["Wed"]], '00ffff'
bc.data "Thursday", [dayhash["Thu"]], 'ff0000'
bc.data "Friday", [dayhash["Fri"]], 'ff00ff'
bc.data "Saturday", [dayhash["Sat"]], 'ffff00'
puts bc.to_url
end

[[File:img2333.jpg]]

Running the above mining script provides the result of the execution of the tweet-days script in the above Listing for the developerWorks account. As shown, Wednesday tends to be the most active tweet day, with Saturday and Sunday the least active.

==References==

<references/>

==Further Reading==
# Rudi Cilibrasi(2008,Oct 4)''CompLearn: A compression-based data-mining toolkit.'' Retrieved from http://www.ruby-doc.org/gems/docs/c/complearn-0.6.2/doc/readme_txt.html

# Seamus Abshere and Andy Rossmeissl (2012, May 14) Real time example of Data Mining Rails Example.[http://impact.brighterplanet.com/] Retrieved from http://www.rubydoc.info/gems/data_miner-ruby19/frames

==Terminology==

CSC/ECE 517 Fall 2013/ch1 1w46 ka

2013-10-08T00:31:49Z

Knjhaver: /* Data Mining in Rails Application */

== Introduction to Data Mining in Rails Application ==

Data mining <ref name="mining> Usama Fayyad, Gregory Piatetsky-Shapiro and Padhraic Smyth. (2008, Dec 17). ''From Data Mining to Knowledge Discoveries in Databases.'' Retrieved from http://www.kdnuggets.com/gpspubs/aimag-kdd-overview-1996-Fayyad.pdf</ref> (the analysis step of the "Knowledge Discovery in Databases" process, or KDD) is the computational process of discovering patterns in large data sets involving methods at the intersection of artificial intelligence, machine learning, statistics, and database systems. The overall goal of the data mining process is to extract information from a data set and transform it into an understandable structure for further use.

Ruby on Rails, often simply Rails, is an open source web application framework which runs on the Ruby programming language. Data mining techniques like <code> [http://en.wikipedia.org/wiki/K-means_clustering K-means clustering] </code> can be developed on ruby on rails by using various gems which ruby provides.
Thus it becomes easier for a data mining analyst to write mining code in a ruby on rails application.

==Weka and Ruby==

<code>[http://www.cs.waikato.ac.nz/ml/weka/ Weka]</code> is a collection of <code>[http://en.wikipedia.org/wiki/Machine_learning machine learning]</code> algorithms for data mining tasks. The algorithms can either be applied directly to a dataset or called from an embedded code. Weka contains tools for data pre-processing, classification, regression, clustering, association rules, and visualization.[http://www.ibm.com/developerworks/library/ba-data-mining-techniques/] It is also well-suited for developing new machine learning schemes. Weka is written in Java however it is possible to use Weka’s libraries inside Ruby. To do this, we must install Java, <code>[http://rubygems.org/gems/rjb Rjb]</code>, and of course obtain the Weka source code. We use <code>[https://github.com/jruby/jruby/wiki/AboutJRuby JRuby]</code> and this is illustrated as follows: <ref name="wekaruby">Peter Lane. (2009, Aug 15). ''Accessing Weka with JRuby.'' Retrieved from http://rubyforscientificresearch.blogspot.com/2009/08/accessing-weka-from-jruby.html</ref>

===Clustering Data using WEKA from JRuby===

JRuby provides easy access to Java classes and methods, and WEKA is no exception. The following program builds a simple k-means cluster on a supplied input file, and then prints out the assigned cluster for each data instance. The 'include_class' statements are there to simplify references to classes in the API. When classifying each instance, we must watch for the exception thrown in case a classification cannot be made. Finally, notice that the filename is passed as a command-line parameter: the parameters after the name of the JRuby program are packaged up into ARGV in the usual ruby style. Assuming weka.jar, jruby.jar, and your program are in the same folder, a sample Ruby example is shown bellow:

# Weka scripting from jruby
require "java"
require "weka"
include_class "java.io.FileReader"
include_class "weka.clusterers.SimpleKMeans"
include_class "weka.core.Instances"

# load data file
file = FileReader.new ARGV[0]
data = Instances.new file

# create the model
kmeans = SimpleKMeans.new
kmeans.buildClusterer data

# print out the built model
print kmeans

# Display the cluster for each instance
data.numInstances.times do |i|
cluster = "UNKNOWN"
begin
cluster = kmeans.clusterInstance(data.instance(i))
rescue java.lang.Exception
end
puts "#{data.instance(i)},#{cluster}"
end

We can see that the WEKA API makes it easy to pass in a data file. Data can be in a number of formats, including <code>[http://www.cs.waikato.ac.nz/ml/weka/arff.html ARFF]</code> and <code>[http://docs.python.org/2/library/csv.html CSV]</code>. When run on the weather.arff example (in WEKA's 'data' folder), the output looks like the following:

Number of iterations: 3
Within cluster sum of squared errors: 16.237456311387238
Missing values globally replaced with mean/mode

Cluster centroids:
Cluster#
Attribute Full Data 0 1
(14) (9) (5)

outlook sunny sunny overcast
temperature 73.5714 75.8889 69.4
humidity 81.6429 84.1111 77.2
windy FALSE FALSE TRUE
play yes yes yes

===Advantages of using Weka from jRuby===

One of the advantages of using a language like jruby to talk to WEKA is that we should have more control on how our data is constructed and passed to the machine-learning algorithms. A good start is how to construct our own set of instances, rather than reading them directly in from file. There are some quirks to WEKA's construction of a set of instances. In particular, each attribute must be defined through an instance of the Attribute class. This class gives a string name to the attribute and if the attribute is a nominal attribute, the class also holds a vector of the nominal values. Each instance can then be constructed and added to the growing set of instances.

==Popular gems for Data Mining==

Since data mining is a complex process of retrieving data from a huge set of databases, many gems are used to ease this procedure in a rails application. Some of the popular gems are RVol, Rbbt and RubyBand. They are explained below.

===RVol===

Gem for creating a database for data mining stock markets focusing on <code> [http://www.spindices.com/indices/equity/sp-500 SP500]</code> data. Rvol enables investors to study market volatility from free data on the internet. RVol is the most popular gem for data mining applications developed in Rails. The created database could be used for instance from <code>[https://www.stat.auckland.ac.nz/~ihaka/downloads/Interface98.pdf R] </code> or <code> [http://www.altiusdirectory.com/Computers/matlab-programming-language.php Matlab]</code> or similar to do quantitative analysis. You could script new data mining functions extending the Rvol library, load the data into a statistics package, or use it with your own quantitative framework. Usage: rvol -s will create the database. The database contains stocks (with industries), options, implied volatility and calculated standard deviations for the day. Earnings are downloaded and listed with implied volatilities for front and back month options. There are some reports, which can be generated after the database is downloaded by looking at rvol -p. There is a function to calculate correlations between stocks in the same industry groups (--correlationAll, --correlation10 (10 day correlation),this will take a long time and jruby is recommended for a better use of system resources. Rvol downloads option chains, calculates implied volatilities for them and has features to list top 10 type of lists for potential investment opportunities. 'Put' call ratios are calculated , total amount of 'puts' or 'calls' for a particular company etc are available. These can be used to measure the market sentiment. Different filters can be used to find stocks/options with high volatilities, stocks with high options volume for the day etc which are indicators of forthcoming events. <ref name="rvol">Toni Karhu. (2012, Aug 18). ''The Ruby ToolBox: RVol.'' Retrieved from https://www.ruby-toolbox.com/projects/rvol</ref>

====Installation of RVol====

Since RVol is a Ruby Gem, we must install it by including it in the Gem file of our Rails application. Version 0.6.4 is the latest and the most stable version by Tonic.

gem install rvol -v 0.6.4

====Example: Use of RVol to Generate stock market databases====

RVol is commonly used to populate databases for Mining stock market data. A sample code snippet below shows the simple way to generate a test database from internet data. <ref name="rvolEg">Toni Karhu. (2012, Aug 19). ''A ruby gem for downloading and processing options chains and financial data.'' Retrieved from https://github.com/tonik/rvol</ref>

require 'Rvol'
require 'test/unit'
require 'dm-core'
require 'dm-migrations'
require 'model/stock'
require 'model/chain'
require 'model/earning'
require 'model/stockcorrelation'

#set the test db an in memory db
DataMapper::Logger.new($stdout, :debug)

puts File.dirname(__FILE__)

DataMapper.setup(:default, "sqlite::memory:")
DataMapper.finalize
DataMapper.auto_migrate!

# GENERATE THE TEST DATABASE FROM INTERNET DATA

puts 'GENERATING TEST DATABASE AND TESTING SCRAPERS'

end

===Rbbt===

Rbbt stands for Ruby Bio-Text, it started as an API for <code> [http://people.ischool.berkeley.edu/~hearst/text-mining.html text mining] </code> developed for <code> [http://sent.dacya.ucm.es/ SENT] </code>, but its functionality has been used for other applications as well, such as <code> [http://marq.dacya.ucm.es/ MARQ] </code>. Rbbt covers several functionalities, some will work right away, some require to install dependencies or download and process data from the internet. Since not all users are likely to need all the functionalities, the dependencies of this gem include only the very basic requirements. Dependencies may appear unexpectedly when using new parts of the API. <ref name="rbbt">Miguel Vazquez. (2013, June 10). ''Rbbt.'' Retrieved from http://rubydoc.info/gems/rbbt/frames</ref>

====Installation of Rbbt====

Install the gem normally gem install rbbt. The gem includes a configuration tool rbbt_config. The first time you run it, it will ask you to configure some paths. After that you may use it to process the data for different tasks.

====Example: Use of Rbbt to translate identifiers====

1. Do rbbt_config prepare identifiers to do deploy the configuration files and enter 'gene' data, this needs to be done just once.

2. Now you may do rbbt_config install 'organisms' to process all the 'organisms', or rbbt_config install organisms such as 'yeast'.

3. You may now use a script like this to translate 'gene' identifiers from 'yeast' feed from the standard input.

require 'rbbt/sources/organism'

index = Organism.id_index('Sce', :native => 'Enter Gene Id')

STDIN.each_line{|l| puts "#{l.chomp} => #{index[l.chomp]}"}

===Ruby Band===

Ruby Band is a Ruby Gem that makes use of some selected Java software for data mining and machine learning applications available to the JRuby/Ruby users. Ruby Band features a comprehensive collection of data preprocessing and modeling techniques, and supports several standard data mining tasks, more specifically: data pre-processing (filtering), clustering, classification, regression, and <code> [http://jmlr.org/papers/v3/guyon03a.html feature selection] </code>. <ref name="rubyband">Alberto Arrigoni. (2013, Sept 24). ''Data Mining in JRuby with Ruby Band.'' Retrieved from http://sciruby.com/blog/2013/09/24/gsoc-2013-data-mining-in-jruby-with-ruby-band</ref>

====Installation of Ruby Band====

Install the 'jbundle' gem and 'bundle' for JRuby before trying to install the 'ruby-band' gem.

If you want to use 'ruby-band' APIs without installing the gem you need to run command 'rake -T' once before requiring the gem in your script (this is necessary for jbundler to download the '.jar' files and subsequently set the Java classpath). Otherwise use:

gem install ruby-band

====Example: Use of Ruby Band for Data Parsing====

One central datatype of ruby-band is derived from the Weka counterpart (the class Weka.core.Instances). By instantiating this class, we obtain a matrix-like structure for storing an entire dataset. Ad-hoc methods were created to guarantee that 'Instances' class objects can be converted to other datatypes (e.g. Apache matrix) and back. There are currently many ways to import data into ruby-band. But the basic way is to Parse data from ARFF/CSV files. <ref name="rubybandGit">Alberto Arrigoni. (2013, Sept 23). ''Ruby-Band Examples.'' Retrieved from https://github.com/arrigonialberto86/ruby-band</ref>

You can simply parse an external Weka ARFF/CSV file by doing:

require 'ruby-band'
dataset = Core::Parser.parse_ARFF(my_file.arff)
dataset = Core::Parser.parse_CSV(my_file.csv)

====Example: Use of Ruby Band for Data Classification====

Classification and regression algorithms in WEKA are called “classifiers” and are located below the Weka::Classifier:: module. Currently, ruby-band only supports batch-trainable classifiers: this means they get trained on the whole dataset at once. Below is a quick example of how to train a classifier on a dataset parsed from an '''<code>[http://www.cs.waikato.ac.nz/ml/weka/arff.html ARFF]</code>'''(attribute relation file format). <ref name="rubybandGit">Alberto Arrigoni. (2013, Sept 23). ''Ruby-Band Examples.'' Retrieved from https://github.com/arrigonialberto86/ruby-band</ref>

require 'ruby-band'

# parse a dataset
dataset = Core::Parser.parse_ARFF(my_file.arff)

# initialize and train a classifier
classifier = Weka::Classifier::Lazy::KStar::Base.new do
set_options '-M d'
set_data dataset
set_class_index 4
end

# cross-validate the trained classifier
puts classifier.cross_validate(3)

====Example: Use of Ruby Band for Data Clustering====

Clustering is an unsupervised Machine Learning technique of finding patterns in the data, i.e., these algorithms work without class attributes. Classifiers, on the other hand, are supervised and need a class attribute. This section, similar to the one about classifiers, covers the following topics:
* Building a clusterer - batch (incremental must still be implemented) learning.
* Evaluating a clusterer - how to evaluate a built clusterer.
* Clustering instances - determining what clusters unknown instances belong to. <ref name="rubybandGit">Alberto Arrigoni. (2013, Sept 23). ''Ruby-Band Examples.'' Retrieved from https://github.com/arrigonialberto86/ruby-band</ref>

==Data Mining with Ruby and Twitter==

The following sections present a few scripts for collecting and presenting data available through the Twitter API. These scripts focus on simplicity, but you can extend and combine them to create new capabilities. <ref name="TwitterData">M. Tim Jones. (2011, Oct 11). ''Data Mining with Ruby and Twitter.'' Retrieved from http://www.ibm.com/developerworks/library/os-dataminingrubytwitter/os-dataminingrubytwitter-pdf.pdf</ref>

===Twitter User Information===

A large amount of information is available about each Twitter user. This information is only accessible if the user isn't protected. Let's look at how you can extract a user's data and present it in a more convenient way. Listing below presents a simple Ruby script to retrieve a user's information (based on his or her screen name), and then emit some of the more useful elements. You use the 'to_s' Ruby method to convert the value to a string as needed. Note that you first ensure that the user isn't protected; otherwise, this data wouldn't be accessible.

#!/usr/bin/env ruby
require "rubygems"
require "twitter"

screen_name = String.new ARGV[0]

a_user = Twitter.user(screen_name)

if a_user.protected != true

puts "Username : " + a_user.screen_name.to_s
puts "Name : " + a_user.name
puts "Id : " + a_user.id_str
puts "Location : " + a_user.location
puts "User since : " + a_user.created_at.to_s
puts "Bio : " + a_user.description.to_s
puts "Followers : " + a_user.followers_count.to_s
puts "Friends : " + a_user.friends_count.to_s
puts "Listed Cnt : " + a_user.listed_count.to_s
puts "Tweet Cnt : " + a_user.statuses_count.to_s
puts "Geocoded : " + a_user.geo_enabled.to_s
puts "Language : " + a_user.lang
if (a_user.url != nil)
puts "URL : " + a_user.url.to_s
end
if (a_user.time_zone != nil)
puts "Time Zone : " + a_user.time_zone
end
puts "Verified : " + a_user.verified.to_s
puts

tweet = Twitter.user_timeline(screen_name).first

puts "Tweet time : " + tweet.created_at
puts "Tweet ID : " + tweet.id.to_s
puts "Tweet text : " + tweet.text

end

===Twitter User Behavior===

Twitter contains a large amount of data that you can mine to understand some elements of user behavior. Two simple examples are to analyze when a Twitter user tweets and from what application the user tweets. You can use the following two simple scripts to extract and visualize this information. Listing below presents a script that iterates the tweets from a particular user (using the user_timeline method), and then for each tweet, extracts the particular day on which the tweet originated. You use a simple hash again to accumulate your weekday counts, then generate a bar chart using Google Charts in a similar fashion to the previous time zone example. Note also the use of default for the hash, which specifies the value to return for undefined hashes.

#!/usr/bin/env ruby
require "rubygems"
require "twitter"
require "google_chart"

screen_name = String.new ARGV[0]

dayhash = Hash.new

# Initialize to avoid a nil error with GoogleCharts (undefined is zero)
dayhash.default = 0

timeline = Twitter.user_timeline(screen_name, :count => 200 )
timeline.each do |t|

tweetday = t.created_at.to_s[0..2]

if dayhash.has_key?(tweetday)
dayhash[tweetday] = dayhash[tweetday] + 1
else
dayhash[tweetday] = 1
end

end

We need to retrieve a BarChart to display per day tweet activity.

GoogleChart::BarChart.new('300x200', screen_name, :vertical, false) do |bc|
bc.data "Sunday", [dayhash["Sun"]], '00000f'
bc.data "Monday", [dayhash["Mon"]], '0000ff'
bc.data "Tuesday", [dayhash["Tue"]], '00ff00'
bc.data "Wednesday", [dayhash["Wed"]], '00ffff'
bc.data "Thursday", [dayhash["Thu"]], 'ff0000'
bc.data "Friday", [dayhash["Fri"]], 'ff00ff'
bc.data "Saturday", [dayhash["Sat"]], 'ffff00'
puts bc.to_url
end

[[File:img2333.jpg]]

Running the above mining script provides the result of the execution of the tweet-days script in the above Listing for the developerWorks account. As shown, Wednesday tends to be the most active tweet day, with Saturday and Sunday the least active.

==References==

<references/>

==Further Reading==
# Rudi Cilibrasi(2008,Oct 4)''CompLearn: A compression-based data-mining toolkit.'' Retrieved from http://www.ruby-doc.org/gems/docs/c/complearn-0.6.2/doc/readme_txt.html

# Seamus Abshere and Andy Rossmeissl (2012, May 14) Real time example of Data Mining Rails Example.[http://impact.brighterplanet.com/] Retrieved from http://www.rubydoc.info/gems/data_miner-ruby19/frames

==Terminology==