Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-12-04T05:57:17Z

Sjshah: /* Files to be changed */

=Expertiza - Information Display and Student Interaction=

[My main comment is that I would like a mockup of how your screens are going to look, so I can judge if the required info is there and if the UI is intuitive enough.]
Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and its codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
*In the current state instructor should go through all the questionnaires to find the one they are looking for.
*The keyword search functionality is not yet implemented for questionnaires.
*The current student dashboard provides the average score and range of the student’s assignment, review and final score.
*The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
*As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
*A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
*This new dashboard gives the students a comparative statistics for that particular assignment for the entire class.
*Giving the min, mean and max gives the student a range to judge where they stand with respect to the class.
*Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do.
*A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed a significant amount of time ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged===
<ul>
<li>
Model
</li>
questionnaire_type_node.rb
<li>
View
</li>
grades/view_my_scored.html.erb, tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
grades_controller.rb, questionnaires_controller.rb, tree_display_controller.rb
<li>
Database
</li>
db/schema.rb
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Changes made for the project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> questionnaire_type_node.rb </code>
| Model
| Made code changes for searching within a course when required
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades/view_my_scores.html.erb </code>
| View
| Made changes to display tables and the charts generated by the grades_controller
|-
|style="text-align:center;"|''''' 3 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Added an icon for navigation to questionnaires for a given course.
|-
|-
|style="text-align:center;"|''''' 4 '''''
| <code> grades_controller.rb </code>
| Controller
| Table data and graph generation code added so that the grades for the entire class are calculated.
|-
|style="text-align:center;"|''''' 5 '''''
| <code> questionnaires_controller.rb </code>
| Controller
| Added a short method to redirect control with the correct parameters when questionnaires are loaded.
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display_controller.rb </code>
| Controller
| Added some code in the search method to allow searching for questionnaires either by course or in general.
|}

= Screenshots =
<b>1) Better display for assignments:</b><br/>
A new icon for questionnaires added<br/>
[[File:new_icon_view.png|center|frame]]<br/><br/>
On click of icon it will display questionnaires related to the selected course<br/>
[[File:questionnaires_view.png|center|frame]]<br/><br/>
<b>2) Dashboard for students:</b><br/>
It shows the different between previous implementation and new implementation views.

{| class="wikitable"
|-
! Before
! After

|-
| [[File:before_view.png|frame|left| ]]
| [[File:after_view.png|frame|left| ]]

|}

=Use case=
For the instructor, there needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires. A search functionality for questionnaire is expected. Currently, assignment and course searches is implemented, and there is a dropdown for questionnaire, but it's functionality is missing.

'''Actor:''' Instructot

'''Other Participants:''' None

'''Precondition:''' There are few questionnaires in the system

'''Primary Sequence:'''

1. Log in to Expertiza

2. Instructor lands on "Manage content" page

3. Search for a questionnaire, by selecting questionnaire in the search dropdown and input some search string

4. Search results displayed, expanding only the applicable questionnaires in the list of questionnaires

[[File:Assignment_display_existing.jpg]]

The following use case diagram shows the system of Assignment grades for a student on Expertiza as it is depicted right now. These include viewing their own project submission (with url and attachments), reviews and metareviews on their work, author feedbacks, teammate reviews and their final score on that assignment/project.<ref>Previous year's design document for ''E715: Dashboard for Students'' by Ambika Tripathi, Milan Tonse, Krutika Nagar, Shruti Buch</ref> As part of this project we shall be adding more data on this page, so that student has better understanding of his/her marks.

'''Name''': Students viewing scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the average, high and low class score for that particular assignment

'''Name''': Students viewing graphical output for scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the graphical output for average, high and low class score for that particular assignment

'''Name''': Students viewing number of reviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of reviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my reviews for this assignment.

5. View the number of reviews the student has done for that particular assignment and also the

number of reviews he still has to do to reach the threshold.

'''Name''': Students viewing number of metareviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of metareviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my metareviews for this assignment.

5. View the number of metareviews the student has done for that particular assignment and also

the number of metareviews he still has to do to reach the threshold.

'''Name''': Students viewing average number of class reviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class reviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class reviews for this assignment.

5. View the average number of class reviews for that particular assignment

'''Name''': Students viewing average number of class metareviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class metareviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class metareviews for this assignment.

5. View the average number of class metareviews for that particular assignment

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
Following is class diagram for Assignment display module. <ref>Previous year's design document for ''E707: Better display for assignments'' by Bharath Sampath(bsampat2),Prakash Vasudevan(pvasude),Raghavendran Nedunchezhian(rnedunc), Yuchuan Liu(yliu63)</ref>

[[File:UML.jpg]]

Following is class diagram for Dashboard for students module.

[[File:Dashboard.jpg]]

=Steps to check the new implementations=

== The new Student dashboard ==
Sample Test case.
<br>1. Log-in to Expertiza as an student (Username: user480, Password: password).
<br>2. Click on 'Program 1: BackChannel' assignment.
<br>3. Click on the option 'Your Scores'.
<br>4. The dashboard is then displayed with the class statistics along with the new graph added.

== The Questionnaire search ==
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Enter any string in the search box
<br>3. We would be able to see all the questionnaires that have the entered string as a substring in them.

== The Course specific questionnaire list ==
Sample Test case.
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Expand the Courses option.
<br>3. Hover over the Course actions menu for the course 'CSC 517, Spring 2014'.
<br>4. Click on the menu-item that says 'View Questionnaires'.
<br>5. List of questionnaires would be displayed here.
<br>6. Search within the above list of questionnaires is also possible by using the search given in the page.

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-12-04T05:57:01Z

Sjshah: /* Files involved */

=Expertiza - Information Display and Student Interaction=

[My main comment is that I would like a mockup of how your screens are going to look, so I can judge if the required info is there and if the UI is intuitive enough.]
Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and its codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
*In the current state instructor should go through all the questionnaires to find the one they are looking for.
*The keyword search functionality is not yet implemented for questionnaires.
*The current student dashboard provides the average score and range of the student’s assignment, review and final score.
*The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
*As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
*A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
*This new dashboard gives the students a comparative statistics for that particular assignment for the entire class.
*Giving the min, mean and max gives the student a range to judge where they stand with respect to the class.
*Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do.
*A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed a significant amount of time ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged===
<ul>
<li>
Model
</li>
questionnaire_type_node.rb
<li>
View
</li>
grades/view_my_scored.html.erb, tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
grades_controller.rb, questionnaires_controller.rb, tree_display_controller.rb
<li>
Database
</li>
db/schema.rb
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Changes made for the project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> questionnaire_type_node.rb </code>
| Model
| Made code changes for searching within a course when required
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades/view_my_scores.html.erb </code>
| View
| Made changes to display tables and the charts generated by the grades_controller
|-
|style="text-align:center;"|''''' 3 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Added an icon for navigation to questionnaires for a given course.
|-
|-
|style="text-align:center;"|''''' 4 '''''
| <code> grades_controller.rb </code>
| Controller
| Table data and graph generation code added so that the grades for the entire class are calculated.
|-
|style="text-align:center;"|''''' 5 '''''
| <code> questionnaires_controller.rb </code>
| Controller
| Added a short method to redirect control with the correct parameters when questionnaires are loaded.
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display_controller.rb </code>
| Controller
| Added some code in the search method to allow searching for questionnaires either by course or in general.
|}

===Files to be changed===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality involved for implementation
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 8 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|}

= Screenshots =
<b>1) Better display for assignments:</b><br/>
A new icon for questionnaires added<br/>
[[File:new_icon_view.png|center|frame]]<br/><br/>
On click of icon it will display questionnaires related to the selected course<br/>
[[File:questionnaires_view.png|center|frame]]<br/><br/>
<b>2) Dashboard for students:</b><br/>
It shows the different between previous implementation and new implementation views.

{| class="wikitable"
|-
! Before
! After

|-
| [[File:before_view.png|frame|left| ]]
| [[File:after_view.png|frame|left| ]]

|}

=Use case=
For the instructor, there needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires. A search functionality for questionnaire is expected. Currently, assignment and course searches is implemented, and there is a dropdown for questionnaire, but it's functionality is missing.

'''Actor:''' Instructot

'''Other Participants:''' None

'''Precondition:''' There are few questionnaires in the system

'''Primary Sequence:'''

1. Log in to Expertiza

2. Instructor lands on "Manage content" page

3. Search for a questionnaire, by selecting questionnaire in the search dropdown and input some search string

4. Search results displayed, expanding only the applicable questionnaires in the list of questionnaires

[[File:Assignment_display_existing.jpg]]

The following use case diagram shows the system of Assignment grades for a student on Expertiza as it is depicted right now. These include viewing their own project submission (with url and attachments), reviews and metareviews on their work, author feedbacks, teammate reviews and their final score on that assignment/project.<ref>Previous year's design document for ''E715: Dashboard for Students'' by Ambika Tripathi, Milan Tonse, Krutika Nagar, Shruti Buch</ref> As part of this project we shall be adding more data on this page, so that student has better understanding of his/her marks.

'''Name''': Students viewing scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the average, high and low class score for that particular assignment

'''Name''': Students viewing graphical output for scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the graphical output for average, high and low class score for that particular assignment

'''Name''': Students viewing number of reviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of reviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my reviews for this assignment.

5. View the number of reviews the student has done for that particular assignment and also the

number of reviews he still has to do to reach the threshold.

'''Name''': Students viewing number of metareviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of metareviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my metareviews for this assignment.

5. View the number of metareviews the student has done for that particular assignment and also

the number of metareviews he still has to do to reach the threshold.

'''Name''': Students viewing average number of class reviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class reviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class reviews for this assignment.

5. View the average number of class reviews for that particular assignment

'''Name''': Students viewing average number of class metareviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class metareviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class metareviews for this assignment.

5. View the average number of class metareviews for that particular assignment

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
Following is class diagram for Assignment display module. <ref>Previous year's design document for ''E707: Better display for assignments'' by Bharath Sampath(bsampat2),Prakash Vasudevan(pvasude),Raghavendran Nedunchezhian(rnedunc), Yuchuan Liu(yliu63)</ref>

[[File:UML.jpg]]

Following is class diagram for Dashboard for students module.

[[File:Dashboard.jpg]]

=Steps to check the new implementations=

== The new Student dashboard ==
Sample Test case.
<br>1. Log-in to Expertiza as an student (Username: user480, Password: password).
<br>2. Click on 'Program 1: BackChannel' assignment.
<br>3. Click on the option 'Your Scores'.
<br>4. The dashboard is then displayed with the class statistics along with the new graph added.

== The Questionnaire search ==
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Enter any string in the search box
<br>3. We would be able to see all the questionnaires that have the entered string as a substring in them.

== The Course specific questionnaire list ==
Sample Test case.
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Expand the Courses option.
<br>3. Hover over the Course actions menu for the course 'CSC 517, Spring 2014'.
<br>4. Click on the menu-item that says 'View Questionnaires'.
<br>5. List of questionnaires would be displayed here.
<br>6. Search within the above list of questionnaires is also possible by using the search given in the page.

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-12-04T05:55:13Z

Sjshah: /* Files to be merged : Dashboard for students */

=Expertiza - Information Display and Student Interaction=

[My main comment is that I would like a mockup of how your screens are going to look, so I can judge if the required info is there and if the UI is intuitive enough.]
Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and its codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
*In the current state instructor should go through all the questionnaires to find the one they are looking for.
*The keyword search functionality is not yet implemented for questionnaires.
*The current student dashboard provides the average score and range of the student’s assignment, review and final score.
*The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
*As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
*A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
*This new dashboard gives the students a comparative statistics for that particular assignment for the entire class.
*Giving the min, mean and max gives the student a range to judge where they stand with respect to the class.
*Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do.
*A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed a significant amount of time ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
questionnaire_type_node.rb
<li>
View
</li>
grades/view_my_scored.html.erb, tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
grades_controller.rb, questionnaires_controller.rb, tree_display_controller.rb
<li>
Database
</li>
db/schema.rb
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Changes made for the project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> questionnaire_type_node.rb </code>
| Model
| Made code changes for searching within a course when required
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades/view_my_scores.html.erb </code>
| View
| Made changes to display tables and the charts generated by the grades_controller
|-
|style="text-align:center;"|''''' 3 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Added an icon for navigation to questionnaires for a given course.
|-
|-
|style="text-align:center;"|''''' 4 '''''
| <code> grades_controller.rb </code>
| Controller
| Table data and graph generation code added so that the grades for the entire class are calculated.
|-
|style="text-align:center;"|''''' 5 '''''
| <code> questionnaires_controller.rb </code>
| Controller
| Added a short method to redirect control with the correct parameters when questionnaires are loaded.
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display_controller.rb </code>
| Controller
| Added some code in the search method to allow searching for questionnaires either by course or in general.
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality involved for implementation
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 8 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|}

= Screenshots =
<b>1) Better display for assignments:</b><br/>
A new icon for questionnaires added<br/>
[[File:new_icon_view.png|center|frame]]<br/><br/>
On click of icon it will display questionnaires related to the selected course<br/>
[[File:questionnaires_view.png|center|frame]]<br/><br/>
<b>2) Dashboard for students:</b><br/>
It shows the different between previous implementation and new implementation views.

{| class="wikitable"
|-
! Before
! After

|-
| [[File:before_view.png|frame|left| ]]
| [[File:after_view.png|frame|left| ]]

|}

=Use case=
For the instructor, there needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires. A search functionality for questionnaire is expected. Currently, assignment and course searches is implemented, and there is a dropdown for questionnaire, but it's functionality is missing.

'''Actor:''' Instructot

'''Other Participants:''' None

'''Precondition:''' There are few questionnaires in the system

'''Primary Sequence:'''

1. Log in to Expertiza

2. Instructor lands on "Manage content" page

3. Search for a questionnaire, by selecting questionnaire in the search dropdown and input some search string

4. Search results displayed, expanding only the applicable questionnaires in the list of questionnaires

[[File:Assignment_display_existing.jpg]]

The following use case diagram shows the system of Assignment grades for a student on Expertiza as it is depicted right now. These include viewing their own project submission (with url and attachments), reviews and metareviews on their work, author feedbacks, teammate reviews and their final score on that assignment/project.<ref>Previous year's design document for ''E715: Dashboard for Students'' by Ambika Tripathi, Milan Tonse, Krutika Nagar, Shruti Buch</ref> As part of this project we shall be adding more data on this page, so that student has better understanding of his/her marks.

'''Name''': Students viewing scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the average, high and low class score for that particular assignment

'''Name''': Students viewing graphical output for scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the graphical output for average, high and low class score for that particular assignment

'''Name''': Students viewing number of reviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of reviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my reviews for this assignment.

5. View the number of reviews the student has done for that particular assignment and also the

number of reviews he still has to do to reach the threshold.

'''Name''': Students viewing number of metareviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of metareviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my metareviews for this assignment.

5. View the number of metareviews the student has done for that particular assignment and also

the number of metareviews he still has to do to reach the threshold.

'''Name''': Students viewing average number of class reviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class reviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class reviews for this assignment.

5. View the average number of class reviews for that particular assignment

'''Name''': Students viewing average number of class metareviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class metareviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class metareviews for this assignment.

5. View the average number of class metareviews for that particular assignment

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
Following is class diagram for Assignment display module. <ref>Previous year's design document for ''E707: Better display for assignments'' by Bharath Sampath(bsampat2),Prakash Vasudevan(pvasude),Raghavendran Nedunchezhian(rnedunc), Yuchuan Liu(yliu63)</ref>

[[File:UML.jpg]]

Following is class diagram for Dashboard for students module.

[[File:Dashboard.jpg]]

=Steps to check the new implementations=

== The new Student dashboard ==
Sample Test case.
<br>1. Log-in to Expertiza as an student (Username: user480, Password: password).
<br>2. Click on 'Program 1: BackChannel' assignment.
<br>3. Click on the option 'Your Scores'.
<br>4. The dashboard is then displayed with the class statistics along with the new graph added.

== The Questionnaire search ==
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Enter any string in the search box
<br>3. We would be able to see all the questionnaires that have the entered string as a substring in them.

== The Course specific questionnaire list ==
Sample Test case.
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Expand the Courses option.
<br>3. Hover over the Course actions menu for the course 'CSC 517, Spring 2014'.
<br>4. Click on the menu-item that says 'View Questionnaires'.
<br>5. List of questionnaires would be displayed here.
<br>6. Search within the above list of questionnaires is also possible by using the search given in the page.

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-12-04T05:54:07Z

Sjshah: /* Files to be merged : Dashboard for students */

=Expertiza - Information Display and Student Interaction=

[My main comment is that I would like a mockup of how your screens are going to look, so I can judge if the required info is there and if the UI is intuitive enough.]
Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and its codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
*In the current state instructor should go through all the questionnaires to find the one they are looking for.
*The keyword search functionality is not yet implemented for questionnaires.
*The current student dashboard provides the average score and range of the student’s assignment, review and final score.
*The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
*As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
*A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
*This new dashboard gives the students a comparative statistics for that particular assignment for the entire class.
*Giving the min, mean and max gives the student a range to judge where they stand with respect to the class.
*Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do.
*A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed a significant amount of time ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
questionnaire_type_node.rb
<li>
View
</li>
grades\view_my_scored.html.erb, tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
grades_controller.rb, questionnaires_controller.rb, tree_display_controller.rb
<li>
Database
</li>
db/schema.rb
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Changes made for the project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> questionnaire_type_node.rb </code>
| Model
| Made code changes for searching within a course when required
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Made changes to display tables and the charts generated by the grades_controller
|-
|style="text-align:center;"|''''' 3 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Added an icon for navigation to questionnaires for a given course.
|-
|-
|style="text-align:center;"|''''' 4 '''''
| <code> grades_controller.rb </code>
| Controller
| Table data and graph generation code added so that the grades for the entire class are calculated.
|-
|style="text-align:center;"|''''' 5 '''''
| <code> questionnaires_controller.rb </code>
| Controller
| Added a short method to redirect control with the correct parameters when questionnaires are loaded.
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display_controller.rb </code>
| Controller
| Added some code in the search method to allow searching for questionnaires either by course or in general.
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality involved for implementation
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 8 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|}

= Screenshots =
<b>1) Better display for assignments:</b><br/>
A new icon for questionnaires added<br/>
[[File:new_icon_view.png|center|frame]]<br/><br/>
On click of icon it will display questionnaires related to the selected course<br/>
[[File:questionnaires_view.png|center|frame]]<br/><br/>
<b>2) Dashboard for students:</b><br/>
It shows the different between previous implementation and new implementation views.

{| class="wikitable"
|-
! Before
! After

|-
| [[File:before_view.png|frame|left| ]]
| [[File:after_view.png|frame|left| ]]

|}

=Use case=
For the instructor, there needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires. A search functionality for questionnaire is expected. Currently, assignment and course searches is implemented, and there is a dropdown for questionnaire, but it's functionality is missing.

'''Actor:''' Instructot

'''Other Participants:''' None

'''Precondition:''' There are few questionnaires in the system

'''Primary Sequence:'''

1. Log in to Expertiza

2. Instructor lands on "Manage content" page

3. Search for a questionnaire, by selecting questionnaire in the search dropdown and input some search string

4. Search results displayed, expanding only the applicable questionnaires in the list of questionnaires

[[File:Assignment_display_existing.jpg]]

The following use case diagram shows the system of Assignment grades for a student on Expertiza as it is depicted right now. These include viewing their own project submission (with url and attachments), reviews and metareviews on their work, author feedbacks, teammate reviews and their final score on that assignment/project.<ref>Previous year's design document for ''E715: Dashboard for Students'' by Ambika Tripathi, Milan Tonse, Krutika Nagar, Shruti Buch</ref> As part of this project we shall be adding more data on this page, so that student has better understanding of his/her marks.

'''Name''': Students viewing scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the average, high and low class score for that particular assignment

'''Name''': Students viewing graphical output for scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the graphical output for average, high and low class score for that particular assignment

'''Name''': Students viewing number of reviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of reviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my reviews for this assignment.

5. View the number of reviews the student has done for that particular assignment and also the

number of reviews he still has to do to reach the threshold.

'''Name''': Students viewing number of metareviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of metareviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my metareviews for this assignment.

5. View the number of metareviews the student has done for that particular assignment and also

the number of metareviews he still has to do to reach the threshold.

'''Name''': Students viewing average number of class reviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class reviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class reviews for this assignment.

5. View the average number of class reviews for that particular assignment

'''Name''': Students viewing average number of class metareviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class metareviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class metareviews for this assignment.

5. View the average number of class metareviews for that particular assignment

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
Following is class diagram for Assignment display module. <ref>Previous year's design document for ''E707: Better display for assignments'' by Bharath Sampath(bsampat2),Prakash Vasudevan(pvasude),Raghavendran Nedunchezhian(rnedunc), Yuchuan Liu(yliu63)</ref>

[[File:UML.jpg]]

Following is class diagram for Dashboard for students module.

[[File:Dashboard.jpg]]

=Steps to check the new implementations=

== The new Student dashboard ==
Sample Test case.
<br>1. Log-in to Expertiza as an student (Username: user480, Password: password).
<br>2. Click on 'Program 1: BackChannel' assignment.
<br>3. Click on the option 'Your Scores'.
<br>4. The dashboard is then displayed with the class statistics along with the new graph added.

== The Questionnaire search ==
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Enter any string in the search box
<br>3. We would be able to see all the questionnaires that have the entered string as a substring in them.

== The Course specific questionnaire list ==
Sample Test case.
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Expand the Courses option.
<br>3. Hover over the Course actions menu for the course 'CSC 517, Spring 2014'.
<br>4. Click on the menu-item that says 'View Questionnaires'.
<br>5. List of questionnaires would be displayed here.
<br>6. Search within the above list of questionnaires is also possible by using the search given in the page.

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-12-04T05:50:32Z

Sjshah: /* Functionality of each file */

=Expertiza - Information Display and Student Interaction=

[My main comment is that I would like a mockup of how your screens are going to look, so I can judge if the required info is there and if the UI is intuitive enough.]
Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and its codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
*In the current state instructor should go through all the questionnaires to find the one they are looking for.
*The keyword search functionality is not yet implemented for questionnaires.
*The current student dashboard provides the average score and range of the student’s assignment, review and final score.
*The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
*As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
*A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
*This new dashboard gives the students a comparative statistics for that particular assignment for the entire class.
*Giving the min, mean and max gives the student a range to judge where they stand with respect to the class.
*Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do.
*A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed a significant amount of time ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
questionnaire_type_node.rb
<li>
View
</li>
grades\view_my_scored.html.erb, tree_display/actions/_courses_actions.html.erb, tree_display/_page_header.html.erb
<li>
Controller
</li>
grades_controller.rb, questionnaires_controller.rb, tree_display_controller.rb
<li>
Database
</li>
db/schema.rb
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Changes made for the project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> questionnaire_type_node.rb </code>
| Model
| Made code changes for searching within a course when required
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Made changes to display tables and the charts generated by the grades_controller
|-
|style="text-align:center;"|''''' 3 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Added an icon for navigation to questionnaires for a given course.
|-
|-
|style="text-align:center;"|''''' 4 '''''
| <code> grades_controller.rb </code>
| Controller
| Table data and graph generation code added so that the grades for the entire class are calculated.
|-
|style="text-align:center;"|''''' 5 '''''
| <code> questionnaires_controller.rb </code>
| Controller
| Added a short method to redirect control with the correct parameters when questionnaires are loaded.
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display_controller.rb </code>
| Controller
| Added some code in the search method to allow searching for questionnaires either by course or in general.
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality involved for implementation
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 8 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|}

= Screenshots =
<b>1) Better display for assignments:</b><br/>
A new icon for questionnaires added<br/>
[[File:new_icon_view.png|center|frame]]<br/><br/>
On click of icon it will display questionnaires related to the selected course<br/>
[[File:questionnaires_view.png|center|frame]]<br/><br/>
<b>2) Dashboard for students:</b><br/>
It shows the different between previous implementation and new implementation views.

{| class="wikitable"
|-
! Before
! After

|-
| [[File:before_view.png|frame|left| ]]
| [[File:after_view.png|frame|left| ]]

|}

=Use case=
For the instructor, there needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires. A search functionality for questionnaire is expected. Currently, assignment and course searches is implemented, and there is a dropdown for questionnaire, but it's functionality is missing.

'''Actor:''' Instructot

'''Other Participants:''' None

'''Precondition:''' There are few questionnaires in the system

'''Primary Sequence:'''

1. Log in to Expertiza

2. Instructor lands on "Manage content" page

3. Search for a questionnaire, by selecting questionnaire in the search dropdown and input some search string

4. Search results displayed, expanding only the applicable questionnaires in the list of questionnaires

[[File:Assignment_display_existing.jpg]]

The following use case diagram shows the system of Assignment grades for a student on Expertiza as it is depicted right now. These include viewing their own project submission (with url and attachments), reviews and metareviews on their work, author feedbacks, teammate reviews and their final score on that assignment/project.<ref>Previous year's design document for ''E715: Dashboard for Students'' by Ambika Tripathi, Milan Tonse, Krutika Nagar, Shruti Buch</ref> As part of this project we shall be adding more data on this page, so that student has better understanding of his/her marks.

'''Name''': Students viewing scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the average, high and low class score for that particular assignment

'''Name''': Students viewing graphical output for scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the graphical output for average, high and low class score for that particular assignment

'''Name''': Students viewing number of reviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of reviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my reviews for this assignment.

5. View the number of reviews the student has done for that particular assignment and also the

number of reviews he still has to do to reach the threshold.

'''Name''': Students viewing number of metareviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of metareviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my metareviews for this assignment.

5. View the number of metareviews the student has done for that particular assignment and also

the number of metareviews he still has to do to reach the threshold.

'''Name''': Students viewing average number of class reviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class reviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class reviews for this assignment.

5. View the average number of class reviews for that particular assignment

'''Name''': Students viewing average number of class metareviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class metareviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class metareviews for this assignment.

5. View the average number of class metareviews for that particular assignment

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
Following is class diagram for Assignment display module. <ref>Previous year's design document for ''E707: Better display for assignments'' by Bharath Sampath(bsampat2),Prakash Vasudevan(pvasude),Raghavendran Nedunchezhian(rnedunc), Yuchuan Liu(yliu63)</ref>

[[File:UML.jpg]]

Following is class diagram for Dashboard for students module.

[[File:Dashboard.jpg]]

=Steps to check the new implementations=

== The new Student dashboard ==
Sample Test case.
<br>1. Log-in to Expertiza as an student (Username: user480, Password: password).
<br>2. Click on 'Program 1: BackChannel' assignment.
<br>3. Click on the option 'Your Scores'.
<br>4. The dashboard is then displayed with the class statistics along with the new graph added.

== The Questionnaire search ==
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Enter any string in the search box
<br>3. We would be able to see all the questionnaires that have the entered string as a substring in them.

== The Course specific questionnaire list ==
Sample Test case.
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Expand the Courses option.
<br>3. Hover over the Course actions menu for the course 'CSC 517, Spring 2014'.
<br>4. Click on the menu-item that says 'View Questionnaires'.
<br>5. List of questionnaires would be displayed here.
<br>6. Search within the above list of questionnaires is also possible by using the search given in the page.

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-12-04T05:49:06Z

Sjshah: /* Functionality of each file */

=Expertiza - Information Display and Student Interaction=

[My main comment is that I would like a mockup of how your screens are going to look, so I can judge if the required info is there and if the UI is intuitive enough.]
Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and its codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
*In the current state instructor should go through all the questionnaires to find the one they are looking for.
*The keyword search functionality is not yet implemented for questionnaires.
*The current student dashboard provides the average score and range of the student’s assignment, review and final score.
*The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
*As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
*A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
*This new dashboard gives the students a comparative statistics for that particular assignment for the entire class.
*Giving the min, mean and max gives the student a range to judge where they stand with respect to the class.
*Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do.
*A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed a significant amount of time ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
questionnaire_type_node.rb
<li>
View
</li>
grades\view_my_scored.html.erb, tree_display/actions/_courses_actions.html.erb, tree_display/_page_header.html.erb
<li>
Controller
</li>
grades_controller.rb, questionnaires_controller.rb, tree_display_controller.rb
<li>
Database
</li>
db/schema.rb
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Changes made for the project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> questionnaire_node.rb </code>
| Model
| Made code changes for searching within a course when required
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Made changes to display tables and the charts generated by the grades_controller
|-
|style="text-align:center;"|''''' 3 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Added an icon for navigation to questionnaires for a given course.
|-
|-
|style="text-align:center;"|''''' 4 '''''
| <code> grades_controller.rb </code>
| Controller
| Table data and graph generation code added so that the grades for the entire class are calculated.
|-
|style="text-align:center;"|''''' 5 '''''
| <code> questionnaires_controller.rb </code>
| Controller
| Added a short method to redirect control with the correct parameters when questionnaires are loaded.
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display_controller.rb </code>
| Controller
| Added some code in the search method to allow searching for questionnaires either by course or in general.
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality involved for implementation
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 8 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|}

= Screenshots =
<b>1) Better display for assignments:</b><br/>
A new icon for questionnaires added<br/>
[[File:new_icon_view.png|center|frame]]<br/><br/>
On click of icon it will display questionnaires related to the selected course<br/>
[[File:questionnaires_view.png|center|frame]]<br/><br/>
<b>2) Dashboard for students:</b><br/>
It shows the different between previous implementation and new implementation views.

{| class="wikitable"
|-
! Before
! After

|-
| [[File:before_view.png|frame|left| ]]
| [[File:after_view.png|frame|left| ]]

|}

=Use case=
For the instructor, there needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires. A search functionality for questionnaire is expected. Currently, assignment and course searches is implemented, and there is a dropdown for questionnaire, but it's functionality is missing.

'''Actor:''' Instructot

'''Other Participants:''' None

'''Precondition:''' There are few questionnaires in the system

'''Primary Sequence:'''

1. Log in to Expertiza

2. Instructor lands on "Manage content" page

3. Search for a questionnaire, by selecting questionnaire in the search dropdown and input some search string

4. Search results displayed, expanding only the applicable questionnaires in the list of questionnaires

[[File:Assignment_display_existing.jpg]]

The following use case diagram shows the system of Assignment grades for a student on Expertiza as it is depicted right now. These include viewing their own project submission (with url and attachments), reviews and metareviews on their work, author feedbacks, teammate reviews and their final score on that assignment/project.<ref>Previous year's design document for ''E715: Dashboard for Students'' by Ambika Tripathi, Milan Tonse, Krutika Nagar, Shruti Buch</ref> As part of this project we shall be adding more data on this page, so that student has better understanding of his/her marks.

'''Name''': Students viewing scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the average, high and low class score for that particular assignment

'''Name''': Students viewing graphical output for scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the graphical output for average, high and low class score for that particular assignment

'''Name''': Students viewing number of reviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of reviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my reviews for this assignment.

5. View the number of reviews the student has done for that particular assignment and also the

number of reviews he still has to do to reach the threshold.

'''Name''': Students viewing number of metareviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of metareviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my metareviews for this assignment.

5. View the number of metareviews the student has done for that particular assignment and also

the number of metareviews he still has to do to reach the threshold.

'''Name''': Students viewing average number of class reviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class reviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class reviews for this assignment.

5. View the average number of class reviews for that particular assignment

'''Name''': Students viewing average number of class metareviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class metareviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class metareviews for this assignment.

5. View the average number of class metareviews for that particular assignment

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
Following is class diagram for Assignment display module. <ref>Previous year's design document for ''E707: Better display for assignments'' by Bharath Sampath(bsampat2),Prakash Vasudevan(pvasude),Raghavendran Nedunchezhian(rnedunc), Yuchuan Liu(yliu63)</ref>

[[File:UML.jpg]]

Following is class diagram for Dashboard for students module.

[[File:Dashboard.jpg]]

=Steps to check the new implementations=

== The new Student dashboard ==
Sample Test case.
<br>1. Log-in to Expertiza as an student (Username: user480, Password: password).
<br>2. Click on 'Program 1: BackChannel' assignment.
<br>3. Click on the option 'Your Scores'.
<br>4. The dashboard is then displayed with the class statistics along with the new graph added.

== The Questionnaire search ==
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Enter any string in the search box
<br>3. We would be able to see all the questionnaires that have the entered string as a substring in them.

== The Course specific questionnaire list ==
Sample Test case.
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Expand the Courses option.
<br>3. Hover over the Course actions menu for the course 'CSC 517, Spring 2014'.
<br>4. Click on the menu-item that says 'View Questionnaires'.
<br>5. List of questionnaires would be displayed here.
<br>6. Search within the above list of questionnaires is also possible by using the search given in the page.

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-12-04T05:48:43Z

Sjshah: /* Functionality of each file */

=Expertiza - Information Display and Student Interaction=

[My main comment is that I would like a mockup of how your screens are going to look, so I can judge if the required info is there and if the UI is intuitive enough.]
Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and its codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
*In the current state instructor should go through all the questionnaires to find the one they are looking for.
*The keyword search functionality is not yet implemented for questionnaires.
*The current student dashboard provides the average score and range of the student’s assignment, review and final score.
*The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
*As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
*A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
*This new dashboard gives the students a comparative statistics for that particular assignment for the entire class.
*Giving the min, mean and max gives the student a range to judge where they stand with respect to the class.
*Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do.
*A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed a significant amount of time ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
questionnaire_type_node.rb
<li>
View
</li>
grades\view_my_scored.html.erb, tree_display/actions/_courses_actions.html.erb, tree_display/_page_header.html.erb
<li>
Controller
</li>
grades_controller.rb, questionnaires_controller.rb, tree_display_controller.rb
<li>
Database
</li>
db/schema.rb
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Changes made for the project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> questionnaire_node.rb </code>
| Model
| Made code changes for searching within a course when required
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Modified in order to display all new features
| Made changes to display tables and the charts generated by the grades_controller
|-
|style="text-align:center;"|''''' 3 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Modified in order to display all new features
| Added an icon for navigation to questionnaires for a given course.
|-
|-
|style="text-align:center;"|''''' 4 '''''
| <code> grades_controller.rb </code>
| Controller
| Table data and graph generation code added so that the grades for the entire class are calculated.
|-
|style="text-align:center;"|''''' 5 '''''
| <code> questionnaires_controller.rb </code>
| Controller
| Added a short method to redirect control with the correct parameters when questionnaires are loaded.
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display_controller.rb </code>
| Controller
| Added some code in the search method to allow searching for questionnaires either by course or in general.
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality involved for implementation
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 8 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|}

= Screenshots =
<b>1) Better display for assignments:</b><br/>
A new icon for questionnaires added<br/>
[[File:new_icon_view.png|center|frame]]<br/><br/>
On click of icon it will display questionnaires related to the selected course<br/>
[[File:questionnaires_view.png|center|frame]]<br/><br/>
<b>2) Dashboard for students:</b><br/>
It shows the different between previous implementation and new implementation views.

{| class="wikitable"
|-
! Before
! After

|-
| [[File:before_view.png|frame|left| ]]
| [[File:after_view.png|frame|left| ]]

|}

=Use case=
For the instructor, there needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires. A search functionality for questionnaire is expected. Currently, assignment and course searches is implemented, and there is a dropdown for questionnaire, but it's functionality is missing.

'''Actor:''' Instructot

'''Other Participants:''' None

'''Precondition:''' There are few questionnaires in the system

'''Primary Sequence:'''

1. Log in to Expertiza

2. Instructor lands on "Manage content" page

3. Search for a questionnaire, by selecting questionnaire in the search dropdown and input some search string

4. Search results displayed, expanding only the applicable questionnaires in the list of questionnaires

[[File:Assignment_display_existing.jpg]]

The following use case diagram shows the system of Assignment grades for a student on Expertiza as it is depicted right now. These include viewing their own project submission (with url and attachments), reviews and metareviews on their work, author feedbacks, teammate reviews and their final score on that assignment/project.<ref>Previous year's design document for ''E715: Dashboard for Students'' by Ambika Tripathi, Milan Tonse, Krutika Nagar, Shruti Buch</ref> As part of this project we shall be adding more data on this page, so that student has better understanding of his/her marks.

'''Name''': Students viewing scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the average, high and low class score for that particular assignment

'''Name''': Students viewing graphical output for scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the graphical output for average, high and low class score for that particular assignment

'''Name''': Students viewing number of reviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of reviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my reviews for this assignment.

5. View the number of reviews the student has done for that particular assignment and also the

number of reviews he still has to do to reach the threshold.

'''Name''': Students viewing number of metareviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of metareviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my metareviews for this assignment.

5. View the number of metareviews the student has done for that particular assignment and also

the number of metareviews he still has to do to reach the threshold.

'''Name''': Students viewing average number of class reviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class reviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class reviews for this assignment.

5. View the average number of class reviews for that particular assignment

'''Name''': Students viewing average number of class metareviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class metareviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class metareviews for this assignment.

5. View the average number of class metareviews for that particular assignment

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
Following is class diagram for Assignment display module. <ref>Previous year's design document for ''E707: Better display for assignments'' by Bharath Sampath(bsampat2),Prakash Vasudevan(pvasude),Raghavendran Nedunchezhian(rnedunc), Yuchuan Liu(yliu63)</ref>

[[File:UML.jpg]]

Following is class diagram for Dashboard for students module.

[[File:Dashboard.jpg]]

=Steps to check the new implementations=

== The new Student dashboard ==
Sample Test case.
<br>1. Log-in to Expertiza as an student (Username: user480, Password: password).
<br>2. Click on 'Program 1: BackChannel' assignment.
<br>3. Click on the option 'Your Scores'.
<br>4. The dashboard is then displayed with the class statistics along with the new graph added.

== The Questionnaire search ==
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Enter any string in the search box
<br>3. We would be able to see all the questionnaires that have the entered string as a substring in them.

== The Course specific questionnaire list ==
Sample Test case.
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Expand the Courses option.
<br>3. Hover over the Course actions menu for the course 'CSC 517, Spring 2014'.
<br>4. Click on the menu-item that says 'View Questionnaires'.
<br>5. List of questionnaires would be displayed here.
<br>6. Search within the above list of questionnaires is also possible by using the search given in the page.

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-12-04T05:33:31Z

Sjshah: /* Changes made in each file */

=Expertiza - Information Display and Student Interaction=

[My main comment is that I would like a mockup of how your screens are going to look, so I can judge if the required info is there and if the UI is intuitive enough.]
Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and its codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
*In the current state instructor should go through all the questionnaires to find the one they are looking for.
*The keyword search functionality is not yet implemented for questionnaires.
*The current student dashboard provides the average score and range of the student’s assignment, review and final score.
*The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
*As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
*A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
*This new dashboard gives the students a comparative statistics for that particular assignment for the entire class.
*Giving the min, mean and max gives the student a range to judge where they stand with respect to the class.
*Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do.
*A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed a significant amount of time ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
questionnaire_type_node.rb
<li>
View
</li>
grades\view_my_scored.html.erb, tree_display/actions/_courses_actions.html.erb, tree_display/_page_header.html.erb
<li>
Controller
</li>
grades_controller.rb, questionnaires_controller.rb, tree_display_controller.rb
<li>
Database
</li>
db/schema.rb
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality involved for implementation
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> questionnaire_type_node.rb </code>
| Model
| Makes an entry into score_cache table whenever a response is given/edited
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 3 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display/_page_header.html.erb </code>
| View
| To get information all information about an assignment and its score which is average score of all reviews and plotting the graph for grade distinction
|-
|-
|style="text-align:center;"|''''' 5 '''''
| <code> grades_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 6 '''''
| <code> questionnaires_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 7 '''''
| <code> tree_display_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 8 '''''
| <code> schema.rb </code>
| Database
| Mapping between response, reviewer and reviewee
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality involved for implementation
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 8 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|}

= Screenshots =
<b>1) Better display for assignments:</b><br/>
A new icon for questionnaires added<br/>
[[File:new_icon_view.png|center|frame]]<br/><br/>
On click of icon it will display questionnaires related to the selected course<br/>
[[File:questionnaires_view.png|center|frame]]<br/><br/>
<b>2) Dashboard for students:</b><br/>
It shows the different between previous implementation and new implementation views.

{| class="wikitable"
|-
! Before
! After

|-
| [[File:before_view.png|frame|left| ]]
| [[File:after_view.png|frame|left| ]]

|}

=Use case=
For the instructor, there needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires. A search functionality for questionnaire is expected. Currently, assignment and course searches is implemented, and there is a dropdown for questionnaire, but it's functionality is missing.

'''Actor:''' Instructot

'''Other Participants:''' None

'''Precondition:''' There are few questionnaires in the system

'''Primary Sequence:'''

1. Log in to Expertiza

2. Instructor lands on "Manage content" page

3. Search for a questionnaire, by selecting questionnaire in the search dropdown and input some search string

4. Search results displayed, expanding only the applicable questionnaires in the list of questionnaires

[[File:Assignment_display_existing.jpg]]

The following use case diagram shows the system of Assignment grades for a student on Expertiza as it is depicted right now. These include viewing their own project submission (with url and attachments), reviews and metareviews on their work, author feedbacks, teammate reviews and their final score on that assignment/project.<ref>Previous year's design document for ''E715: Dashboard for Students'' by Ambika Tripathi, Milan Tonse, Krutika Nagar, Shruti Buch</ref> As part of this project we shall be adding more data on this page, so that student has better understanding of his/her marks.

'''Name''': Students viewing scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the average, high and low class score for that particular assignment

'''Name''': Students viewing graphical output for scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the graphical output for average, high and low class score for that particular assignment

'''Name''': Students viewing number of reviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of reviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my reviews for this assignment.

5. View the number of reviews the student has done for that particular assignment and also the

number of reviews he still has to do to reach the threshold.

'''Name''': Students viewing number of metareviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of metareviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my metareviews for this assignment.

5. View the number of metareviews the student has done for that particular assignment and also

the number of metareviews he still has to do to reach the threshold.

'''Name''': Students viewing average number of class reviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class reviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class reviews for this assignment.

5. View the average number of class reviews for that particular assignment

'''Name''': Students viewing average number of class metareviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class metareviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class metareviews for this assignment.

5. View the average number of class metareviews for that particular assignment

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
Following is class diagram for Assignment display module. <ref>Previous year's design document for ''E707: Better display for assignments'' by Bharath Sampath(bsampat2),Prakash Vasudevan(pvasude),Raghavendran Nedunchezhian(rnedunc), Yuchuan Liu(yliu63)</ref>

[[File:UML.jpg]]

Following is class diagram for Dashboard for students module.

[[File:Dashboard.jpg]]

=Steps to check the new implementations=

== The new Student dashboard ==
Sample Test case.
<br>1. Log-in to Expertiza as an student (Username: user480, Password: password).
<br>2. Click on 'Program 1: BackChannel' assignment.
<br>3. Click on the option 'Your Scores'.
<br>4. The dashboard is then displayed with the class statistics along with the new graph added.

== The Questionnaire search ==
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Enter any string in the search box
<br>3. We would be able to see all the questionnaires that have the entered string as a substring in them.

== The Course specific questionnaire list ==
Sample Test case.
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Expand the Courses option.
<br>3. Hover over the Course actions menu for the course 'CSC 517, Spring 2014'.
<br>4. Click on the menu-item that says 'View Questionnaires'.
<br>5. List of questionnaires would be displayed here.
<br>6. Search within the above list of questionnaires is also possible by using the search given in the page.

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-12-04T05:33:02Z

Sjshah: /* Functionality of each file */

=Expertiza - Information Display and Student Interaction=

[My main comment is that I would like a mockup of how your screens are going to look, so I can judge if the required info is there and if the UI is intuitive enough.]
Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and its codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
*In the current state instructor should go through all the questionnaires to find the one they are looking for.
*The keyword search functionality is not yet implemented for questionnaires.
*The current student dashboard provides the average score and range of the student’s assignment, review and final score.
*The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
*As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
*A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
*This new dashboard gives the students a comparative statistics for that particular assignment for the entire class.
*Giving the min, mean and max gives the student a range to judge where they stand with respect to the class.
*Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do.
*A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed a significant amount of time ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
questionnaire_type_node.rb
<li>
View
</li>
grades\view_my_scored.html.erb, tree_display/actions/_courses_actions.html.erb, tree_display/_page_header.html.erb
<li>
Controller
</li>
grades_controller.rb, questionnaires_controller.rb, tree_display_controller.rb
<li>
Database
</li>
db/schema.rb
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality involved for implementation
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> questionnaire_type_node.rb </code>
| Model
| Makes an entry into score_cache table whenever a response is given/edited
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 3 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display/_page_header.html.erb </code>
| View
| To get information all information about an assignment and its score which is average score of all reviews and plotting the graph for grade distinction
|-
|-
|style="text-align:center;"|''''' 5 '''''
| <code> grades_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 6 '''''
| <code> questionnaires_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 7 '''''
| <code> tree_display_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 8 '''''
| <code> schema.rb </code>
| Database
| Mapping between response, reviewer and reviewee
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

====Functionality of each file====

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality involved for implementation
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 8 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|}

====Changes made in each file====

= Screenshots =
<b>1) Better display for assignments:</b><br/>
A new icon for questionnaires added<br/>
[[File:new_icon_view.png|center|frame]]<br/><br/>
On click of icon it will display questionnaires related to the selected course<br/>
[[File:questionnaires_view.png|center|frame]]<br/><br/>
<b>2) Dashboard for students:</b><br/>
It shows the different between previous implementation and new implementation views.

{| class="wikitable"
|-
! Before
! After

|-
| [[File:before_view.png|frame|left| ]]
| [[File:after_view.png|frame|left| ]]

|}

=Use case=
For the instructor, there needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires. A search functionality for questionnaire is expected. Currently, assignment and course searches is implemented, and there is a dropdown for questionnaire, but it's functionality is missing.

'''Actor:''' Instructot

'''Other Participants:''' None

'''Precondition:''' There are few questionnaires in the system

'''Primary Sequence:'''

1. Log in to Expertiza

2. Instructor lands on "Manage content" page

3. Search for a questionnaire, by selecting questionnaire in the search dropdown and input some search string

4. Search results displayed, expanding only the applicable questionnaires in the list of questionnaires

[[File:Assignment_display_existing.jpg]]

The following use case diagram shows the system of Assignment grades for a student on Expertiza as it is depicted right now. These include viewing their own project submission (with url and attachments), reviews and metareviews on their work, author feedbacks, teammate reviews and their final score on that assignment/project.<ref>Previous year's design document for ''E715: Dashboard for Students'' by Ambika Tripathi, Milan Tonse, Krutika Nagar, Shruti Buch</ref> As part of this project we shall be adding more data on this page, so that student has better understanding of his/her marks.

'''Name''': Students viewing scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the average, high and low class score for that particular assignment

'''Name''': Students viewing graphical output for scores for the assignment

'''Actor''': Student

'''Other Participants''': None

'''Precondition''': Statistics have been recorded for average high and low scores.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class scores for this assignment.

5. View the graphical output for average, high and low class score for that particular assignment

'''Name''': Students viewing number of reviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of reviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my reviews for this assignment.

5. View the number of reviews the student has done for that particular assignment and also the

number of reviews he still has to do to reach the threshold.

'''Name''': Students viewing number of metareviews done by him/her

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for number of metareviews done by the student.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for my metareviews for this assignment.

5. View the number of metareviews the student has done for that particular assignment and also

the number of metareviews he still has to do to reach the threshold.

'''Name''': Students viewing average number of class reviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class reviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class reviews for this assignment.

5. View the average number of class reviews for that particular assignment

'''Name''': Students viewing average number of class metareviews for the assignment

'''Actor''': Student

'''Other Participants:''' None

'''Precondition''': Statistics have been recorded for class metareviews for that assignment.

'''Primary Sequence:'''

1. Log in to Expertiza

2. Select an assignment

3. Select Your Scores

4. Click on the link for view class metareviews for this assignment.

5. View the average number of class metareviews for that particular assignment

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
Following is class diagram for Assignment display module. <ref>Previous year's design document for ''E707: Better display for assignments'' by Bharath Sampath(bsampat2),Prakash Vasudevan(pvasude),Raghavendran Nedunchezhian(rnedunc), Yuchuan Liu(yliu63)</ref>

[[File:UML.jpg]]

Following is class diagram for Dashboard for students module.

[[File:Dashboard.jpg]]

=Steps to check the new implementations=

== The new Student dashboard ==
Sample Test case.
<br>1. Log-in to Expertiza as an student (Username: user480, Password: password).
<br>2. Click on 'Program 1: BackChannel' assignment.
<br>3. Click on the option 'Your Scores'.
<br>4. The dashboard is then displayed with the class statistics along with the new graph added.

== The Questionnaire search ==
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Enter any string in the search box
<br>3. We would be able to see all the questionnaires that have the entered string as a substring in them.

== The Course specific questionnaire list ==
Sample Test case.
<br>1. Log-in to Expertiza as an instructor (Username: user2, Password: password).
<br>2. Expand the Courses option.
<br>3. Hover over the Course actions menu for the course 'CSC 517, Spring 2014'.
<br>4. Click on the menu-item that says 'View Questionnaires'.
<br>5. List of questionnaires would be displayed here.
<br>6. Search within the above list of questionnaires is also possible by using the search given in the page.

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-12T02:42:55Z

Sjshah: /* Approach */

=Expertiza - Information Display and Student Interaction=

Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and it's codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
*In the current state instructor should go through all the questionnaires to find the one they are looking for.
*The keyword search functionality is not yet implemented for questionnaires.
*The current student dashboard provides the average score and range of the student’s assignment, review and final score.
*The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
*As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
*A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
*This new dashboard gives the students a comparative statistics for that particular assignment for the entire class.
*Giving the min, mean and max gives the student a range to judge where they stand with respect to the class.
*Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do.
*A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed a significant amount of time ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
ScoreCache.rb
<li>
View
</li>
grades\view_my_scored.html.erb
<li>
Controller
</li>
grades_controller.rb, review_mapping_controller.rb,response_controller.rb
<li>
Database tables
</li>
Assignments,Participants, score_caches, response_maps,responses
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> ScoreCache.rb </code>
| Model
| Makes an entry into score_cache table whenever a response is given/edited
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 3 '''''
| <code> grades_controller.rb </code>
| Controller
| To get information all information about an assignment and its score which is average score of all reviews and plotting the graph for grade distinction
|-
|style="text-align:center;"|''''' 4 '''''
| <code> review_mapping_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 5 '''''
| <code> Assignments </code>
| Table
| All information related to assignment
|-
|style="text-align:center;"|''''' 6 '''''
| <code> Responses </code>
| Table
| Stores individual assignment review response information
|-
|style="text-align:center;"|''''' 7 '''''
| <code> Score_caches </code>
| Table
| Stores individual assignment review score information
|-
|style="text-align:center;"|''''' 8 '''''
| <code> response_maps </code>
| Table
| Mapping between response, reviewer and reviewee
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 8 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions

|}

=Use case=
[[File:Assignment_display_existing.jpg]]

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
[[File:UML.jpg]]

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-12T02:36:09Z

Sjshah: /* References */

=Expertiza - Information Display and Student Interaction=

Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and it's codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
In the current state instructor should go through all the questionnaires to find the one they are looking for. The keyword search functionality is not yet implemented for questionnaires.

The current student dashboard provides the average score and range of the student’s assignment, review and final score. The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.

A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
This new dashboard gives the students a comparative statistics for that particular assignment for the entire class. Giving the min, mean and max gives the student a range to judge where they stand with respect to the class. Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do. A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed 2 years ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
ScoreCache.rb
<li>
View
</li>
grades\view_my_scored.html.erb
<li>
Controller
</li>
grades_controller.rb, review_mapping_controller.rb,response_controller.rb
<li>
Database tables
</li>
Assignments,Participants, score_caches, response_maps,responses
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> ScoreCache.rb </code>
| Model
| Makes an entry into score_cache table whenever a response is given/edited
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 3 '''''
| <code> grades_controller.rb </code>
| Controller
| To get information all information about an assignment and its score which is average score of all reviews and plotting the graph for grade distinction
|-
|style="text-align:center;"|''''' 4 '''''
| <code> review_mapping_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 5 '''''
| <code> Assignments </code>
| Table
| All information related to assignment
|-
|style="text-align:center;"|''''' 6 '''''
| <code> Responses </code>
| Table
| Stores individual assignment review response information
|-
|style="text-align:center;"|''''' 7 '''''
| <code> Score_caches </code>
| Table
| Stores individual assignment review score information
|-
|style="text-align:center;"|''''' 8 '''''
| <code> response_maps </code>
| Table
| Mapping between response, reviewer and reviewee
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 8 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions

|}

=Use case=
[[File:Assignment_display_existing.jpg]]

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
[[File:UML.jpg]]

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-12T02:35:41Z

Sjshah: /* Testing */

=Expertiza - Information Display and Student Interaction=

Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and it's codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
In the current state instructor should go through all the questionnaires to find the one they are looking for. The keyword search functionality is not yet implemented for questionnaires.

The current student dashboard provides the average score and range of the student’s assignment, review and final score. The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.

A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
This new dashboard gives the students a comparative statistics for that particular assignment for the entire class. Giving the min, mean and max gives the student a range to judge where they stand with respect to the class. Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do. A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed 2 years ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
ScoreCache.rb
<li>
View
</li>
grades\view_my_scored.html.erb
<li>
Controller
</li>
grades_controller.rb, review_mapping_controller.rb,response_controller.rb
<li>
Database tables
</li>
Assignments,Participants, score_caches, response_maps,responses
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> ScoreCache.rb </code>
| Model
| Makes an entry into score_cache table whenever a response is given/edited
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 3 '''''
| <code> grades_controller.rb </code>
| Controller
| To get information all information about an assignment and its score which is average score of all reviews and plotting the graph for grade distinction
|-
|style="text-align:center;"|''''' 4 '''''
| <code> review_mapping_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 5 '''''
| <code> Assignments </code>
| Table
| All information related to assignment
|-
|style="text-align:center;"|''''' 6 '''''
| <code> Responses </code>
| Table
| Stores individual assignment review response information
|-
|style="text-align:center;"|''''' 7 '''''
| <code> Score_caches </code>
| Table
| Stores individual assignment review score information
|-
|style="text-align:center;"|''''' 8 '''''
| <code> response_maps </code>
| Table
| Mapping between response, reviewer and reviewee
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 8 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions

|}

=Use case=
[[File:Assignment_display_existing.jpg]]

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
[[File:UML.jpg]]

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-12T02:35:31Z

Sjshah: /* Specific Approach */

=Expertiza - Information Display and Student Interaction=

Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and it's codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which provides a new dashboard for students to view and compare their performance of each assignment.

==Current State==
In the current state instructor should go through all the questionnaires to find the one they are looking for. The keyword search functionality is not yet implemented for questionnaires.

The current student dashboard provides the average score and range of the student’s assignment, review and final score. The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance.

==Goals==
As a part of our project we will implement the search functionality and also make it possible to click and bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.

A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
This new dashboard gives the students a comparative statistics for that particular assignment for the entire class. Giving the min, mean and max gives the student a range to judge where they stand with respect to the class. Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do. A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed 2 years ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Testing=
=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
ScoreCache.rb
<li>
View
</li>
grades\view_my_scored.html.erb
<li>
Controller
</li>
grades_controller.rb, review_mapping_controller.rb,response_controller.rb
<li>
Database tables
</li>
Assignments,Participants, score_caches, response_maps,responses
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> ScoreCache.rb </code>
| Model
| Makes an entry into score_cache table whenever a response is given/edited
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 3 '''''
| <code> grades_controller.rb </code>
| Controller
| To get information all information about an assignment and its score which is average score of all reviews and plotting the graph for grade distinction
|-
|style="text-align:center;"|''''' 4 '''''
| <code> review_mapping_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 5 '''''
| <code> Assignments </code>
| Table
| All information related to assignment
|-
|style="text-align:center;"|''''' 6 '''''
| <code> Responses </code>
| Table
| Stores individual assignment review response information
|-
|style="text-align:center;"|''''' 7 '''''
| <code> Score_caches </code>
| Table
| Stores individual assignment review score information
|-
|style="text-align:center;"|''''' 8 '''''
| <code> response_maps </code>
| Table
| Mapping between response, reviewer and reviewee
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 8 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions

|}

=Use case=
[[File:Assignment_display_existing.jpg]]

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
[[File:UML.jpg]]

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

File:Dashboard Approach.jpg

2014-11-12T02:33:27Z

Sjshah:

File:Better Display Approach.jpg

2014-11-12T02:30:30Z

Sjshah:

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-12T02:16:51Z

Sjshah: /* Specific Approach */

=Expertiza - Information Display and Student Interaction=

Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and it's codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project would be to improve the display of questionnaires for all the instructors and also integrating a previous project which is a new dashboard for students to view and compare their performance of the assignments.

==Current State==
In the current state instructor should go through all the questionnaires to find the one they are looking for. The keyword search functionality is not yet implemented for it.

The current student dashboard provides the average score and range of the student’s assignment, review and final score. The system has a limitation where in a student/instructor cannot view and compare the student scores based on the class performance. The system also does not show the mean , min and max score for a particular assignment which provides students and instructors deep insight into the comparative performance of students.

==Goals==
As a part of our project we will implement the search functionality and also make it possible to click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.

A project from last year has the implementation for the new student dashboard. We would like to take that project, make the required changes to it and integrate it into expertiza.
So this new dashboard gives the students a comparative statistics for that particular assignment for the entire class. Giving the min, mean and max gives the student a range to judge where they stand with respect to the class. Other features were part of the project were to show the number of reviews and metareviews he/she has done for this assignment and also based on a threshold what are the number of reviews/metareviews the student still needs to do. A histogram distribution of the scores of the class (all teams) for that assignment would also shown as a part of the dashboard.

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed 2 years ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

[[File:Better_Display_Approach.jpg]]

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

[[File:Dashboard_Approach.jpg]]

=Testing=
=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
ScoreCache.rb
<li>
View
</li>
grades\view_my_scored.html.erb
<li>
Controller
</li>
grades_controller.rb, review_mapping_controller.rb,response_controller.rb
<li>
Database tables
</li>
Assignments,Participants, score_caches, response_maps,responses
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> ScoreCache.rb </code>
| Model
| Makes an entry into score_cache table whenever a response is given/edited
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 3 '''''
| <code> grades_controller.rb </code>
| Controller
| To get information all information about an assignment and its score which is average score of all reviews and plotting the graph for grade distinction
|-
|style="text-align:center;"|''''' 4 '''''
| <code> review_mapping_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 5 '''''
| <code> Assignments </code>
| Table
| All information related to assignment
|-
|style="text-align:center;"|''''' 6 '''''
| <code> Responses </code>
| Table
| Stores individual assignment review response information
|-
|style="text-align:center;"|''''' 7 '''''
| <code> Score_caches </code>
| Table
| Stores individual assignment review score information
|-
|style="text-align:center;"|''''' 8 '''''
| <code> response_maps </code>
| Table
| Mapping between response, reviewer and reviewee
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 8 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions

|}

=Use case=
[[File:Assignment_display_existing.jpg]]

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
[[File:UML.jpg]]

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-12T01:39:48Z

Sjshah: /* Better display for assignments */

=Expertiza - Information Display and Student Interaction=

Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and it's codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project is by improving the display of assignments for all the instructors and also to merge a previous project which made a improve the dashboard for student to view and compare their performance of the assignments.
==Background==
==Scope==
==Purpose==

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed 2 years ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*The instructor's courses
*Assignments for those courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Testing=
=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
ScoreCache.rb
<li>
View
</li>
grades\view_my_scored.html.erb
<li>
Controller
</li>
grades_controller.rb, review_mapping_controller.rb,response_controller.rb
<li>
Database tables
</li>
Assignments,Participants, score_caches, response_maps,responses
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> ScoreCache.rb </code>
| Model
| Makes an entry into score_cache table whenever a response is given/edited
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 3 '''''
| <code> grades_controller.rb </code>
| Controller
| To get information all information about an assignment and its score which is average score of all reviews and plotting the graph for grade distinction
|-
|style="text-align:center;"|''''' 4 '''''
| <code> review_mapping_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 5 '''''
| <code> Assignments </code>
| Table
| All information related to assignment
|-
|style="text-align:center;"|''''' 6 '''''
| <code> Responses </code>
| Table
| Stores individual assignment review response information
|-
|style="text-align:center;"|''''' 7 '''''
| <code> Score_caches </code>
| Table
| Stores individual assignment review score information
|-
|style="text-align:center;"|''''' 8 '''''
| <code> response_maps </code>
| Table
| Mapping between response, reviewer and reviewee
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 8 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions

|}

=Use case=
[[File:Assignment_display_existing.jpg]]

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
[[File:UML.jpg]]

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-12T01:38:59Z

Sjshah: /* Dashboard for students */

=Expertiza - Information Display and Student Interaction=

Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and it's codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project is by improving the display of assignments for all the instructors and also to merge a previous project which made a improve the dashboard for student to view and compare their performance of the assignments.
==Background==
==Scope==
==Purpose==

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed 2 years ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*His courses
*Assignments for his courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

The features required for the dashboard for students project have already been implemented. So, the main task to be performed by us is to merge the project files with the main project and make sure that nothing else is affected by the process.

The current code is able to display the maximum scores, average scores, number of reviews and distribution charts.

=Testing=
=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
ScoreCache.rb
<li>
View
</li>
grades\view_my_scored.html.erb
<li>
Controller
</li>
grades_controller.rb, review_mapping_controller.rb,response_controller.rb
<li>
Database tables
</li>
Assignments,Participants, score_caches, response_maps,responses
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> ScoreCache.rb </code>
| Model
| Makes an entry into score_cache table whenever a response is given/edited
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 3 '''''
| <code> grades_controller.rb </code>
| Controller
| To get information all information about an assignment and its score which is average score of all reviews and plotting the graph for grade distinction
|-
|style="text-align:center;"|''''' 4 '''''
| <code> review_mapping_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 5 '''''
| <code> Assignments </code>
| Table
| All information related to assignment
|-
|style="text-align:center;"|''''' 6 '''''
| <code> Responses </code>
| Table
| Stores individual assignment review response information
|-
|style="text-align:center;"|''''' 7 '''''
| <code> Score_caches </code>
| Table
| Stores individual assignment review score information
|-
|style="text-align:center;"|''''' 8 '''''
| <code> response_maps </code>
| Table
| Mapping between response, reviewer and reviewee
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 8 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions

|}

=Use case=
[[File:Assignment_display_existing.jpg]]

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
[[File:UML.jpg]]

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-12T01:33:54Z

Sjshah: /* Better display for assignments */

=Expertiza - Information Display and Student Interaction=

Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)<ref>[https://github.com/expertiza/expertiza Expertiza on GitHub]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza Wiki Page]</ref>. It is an open source project and it's codebase is maintained in GitHub.

__TOC__

=Introduction=
Our contribution in this project is by improving the display of assignments for all the instructors and also to merge a previous project which made a improve the dashboard for student to view and compare their performance of the assignments.
==Background==
==Scope==
==Purpose==

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed 2 years ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible and missing parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

We found that while the currently existing code covers most of the functionality, a major part of the functionality is missing. According to definition, the instructor should see the following on his home page:
*His courses
*Assignments for his courses
*Questionnaire by assignment name

Each of these should be compressed to titles only, and it should be possible to expand them by single mouse click. Each course should have its own list of assignments which can, again, be expanded. Also, there is a search box on the page which allows to search assignments, courses and questionnaires.

The search functionality for assignments and courses is working well, but the search for questionnaires is not implemented.

So, for this specific project, we plan to focus on implementing the search for questionnaires first. Then, integrate it all and test each functionality: make sure that nothing is affected by the new functionality added. After all the tests are performed, we will merge the project with the main project, thus integrating it with the final build.

===Dashboard for students===

=Testing=
=Files involved=
===Files to be merged : Dashboard for students===
<ul>
<li>
Model
</li>
ScoreCache.rb
<li>
View
</li>
grades\view_my_scored.html.erb
<li>
Controller
</li>
grades_controller.rb, review_mapping_controller.rb,response_controller.rb
<li>
Database tables
</li>
Assignments,Participants, score_caches, response_maps,responses
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> ScoreCache.rb </code>
| Model
| Makes an entry into score_cache table whenever a response is given/edited
|-
|style="text-align:center;"|''''' 2 '''''
| <code> grades\view_my_scores.html.erb </code>
| View
| Modified in order to display all new features
|-
|style="text-align:center;"|''''' 3 '''''
| <code> grades_controller.rb </code>
| Controller
| To get information all information about an assignment and its score which is average score of all reviews and plotting the graph for grade distinction
|-
|style="text-align:center;"|''''' 4 '''''
| <code> review_mapping_controller.rb </code>
| Controller
| To get additional information about assignment like total reviews submitted
|-
|style="text-align:center;"|''''' 5 '''''
| <code> Assignments </code>
| Table
| All information related to assignment
|-
|style="text-align:center;"|''''' 6 '''''
| <code> Responses </code>
| Table
| Stores individual assignment review response information
|-
|style="text-align:center;"|''''' 7 '''''
| <code> Score_caches </code>
| Table
| Stores individual assignment review score information
|-
|style="text-align:center;"|''''' 8 '''''
| <code> response_maps </code>
| Table
| Mapping between response, reviewer and reviewee
|}

===Files to be changed : Better display of assignment===
<ul>
<li>
Model
</li>
course_node.rb,assignment_node.rb,questionnaire_node.rb
<li>
View
</li>
tree_display\ _row_header.html.erb,tree_display\ _entry.html.erb,tree_display/actions/_courses_actions.html.erb
<li>
Controller
</li>
tree_display controller.rb,course_controller.rb,assignment_controller.rb,questionnaire_controller.rb
<li>
JavaScript
</li>
tableactions.js
</ul>

===Functionality of each file===

{| class="wikitable"
|-
! style="width:2%;"|Sr. No.
! style="width:8%;"|File Name
!style="width:13%;"| Type
! style="width:43%;"|Functionality for this project
|- style="vertical-align:top;"
|-
|style="text-align:center;"|''''' 1 '''''
| <code> course_node.rb </code>
| Model
| To fetch information about all course none in the system
|-
|style="text-align:center;"|''''' 2 '''''
| <code> assignment_node.rb </code>
| Model
| To fetch information about all assignment node in the system
|-
|style="text-align:center;"|''''' 3 '''''
| <code> questionnaire_node.rb </code>
| Model
| To fetch information about all questionnaire node in the system
|-
|style="text-align:center;"|''''' 4 '''''
| <code> tree_display controller.rb </code>
| Controller
| For direct access to every entity like questionnaires, review rubric etc..
|-
|style="text-align:center;"|''''' 5 '''''
| <code> tree_display\ _row_header.html.erb </code>
| View
| Display of header in a row
|-
|style="text-align:center;"|''''' 6 '''''
| <code> tree_display\ _entry.html.erb </code>
| View
| Display entity in a row
|-
|style="text-align:center;"|''''' 7 '''''
| <code> tree_display/actions/_courses_actions.html.erb </code>
| View
| Display separate actions on each row
|-
|style="text-align:center;"|''''' 8 '''''
| <code> course_controller.rb </code>
| Controller
| Provides various course related functions
|-
|style="text-align:center;"|''''' 9 '''''
| <code> assignment_controller.rb </code>
| Controller
| Provides various assignment related functions
|-
|style="text-align:center;"|''''' 10 '''''
| <code> questionnaire_controller.rb </code>
| Controller
| Provides various questionnaire related functions

|}

=Use case=
[[File:Assignment_display_existing.jpg]]

[[File:Dashboard_existing.jpg]]

[[File:Dashboard_new.jpg]]
=UML diagram=
[[File:UML.jpg]]

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

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-11T21:50:20Z

Sjshah: /* Better display for assignments */

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-11T21:14:59Z

Sjshah: /* Better display for assignments */

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-11T21:11:00Z

Sjshah: /* General Approach */

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-11T14:21:28Z

Sjshah: /* Specific Approach */

Information Display and Student Interaction

=Introduction=
==Background==
==Scope==
==Purpose==

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed 2 years ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two functionality is as follows:
===Better display for assignments===

===Dashboard for students===

=Testing=
=Files involved=
==Functionality of each file==
=Use case=
=UML diagram=

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-11T13:58:31Z

Sjshah: /* Approach */

Information Display and Student Interaction

=Introduction=
==Background==
==Scope==
==Purpose==

=Approach=

As the project was originally assigned to students two years ago, the functionality is mostly complete. The main concern is that, as the project was completed 2 years ago (in December 2012), it was made for an older version of rails.

==General Approach==
Our general approach to the project would be as follows:
*Run the current project with rails 4
*Check the functionality to find out the incompatible parts
*Refactor the parts of code that do not function as expected and port them to rails 4 specification
*After making sure everything runs, refactor the entire code to make sure it follows the global code rules.

==Specific Approach==
The specific approach to each of the two features is as follows:
===Better display for assignments===
===Dashboard for students===

=Testing=
=Files involved=
==Functionality of each file==
=Use case=
=UML diagram=

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-11T02:21:58Z

Sjshah: /* Scope */

Information Display and Student Interaction

=Introduction=
==Background==
==Scope==
==Purpose==

=Approach=
=Testing=
=Files involved=
==Functionality of each file==
=Use case=
=UML diagram=

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-11T02:20:36Z

Sjshah:

Information Display and Student Interaction

=Introduction=
==Scope==
=Approach=
=Testing=
=Files involved=
==Functionality of each file==
=Use case=
=UML diagram=

CSC/ECE 517 Fall 2014/final E1471 asuv

2014-11-11T02:19:57Z

Sjshah: Created page with "Information Display and Student Interaction *Introduction* **Scope** *Approach* *Testing* *Files involved* **Functionality of each file** *Use case* *UML diagram*"

Information Display and Student Interaction

*Introduction*
**Scope**
*Approach*
*Testing*
*Files involved*
**Functionality of each file**
*Use case*
*UML diagram*

CSC/ECE 517 Fall 2014

2014-11-11T02:18:15Z

Sjshah:

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

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

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

CSC/ECE 517 Fall 2014/oss E1457 ags

2014-10-30T00:28:44Z

Sjshah: /* DynamicReviewMapping Controller */

=Expertiza - Refactoring DynamicReviewMapping Controller and the ReportsController=

__TOC__

==Introduction==
It is time consuming to assess project work in a large classroom environment, and one of the best techniques to achieve this is to have students assist in this assessment. If each student is asked to assess a few (say, one to five) other students or student teams, the task requires a reasonable amount of effort; and that effort does not increase as the class gets larger. "''Expertiza is a system for managing all kinds of communication that is involved in assessment: double-blind communications between authors and reviewers, assessment of teammate contributions, evaluations by course staff, and surveys of students to assess the assignment and the
peer-review process.''" <ref>http://www.igi-global.com/book/monitoring-assessment-online-collaborative-environments/773&f=e-book</ref>
''"Expertiza project uses peer review to create reusable learning objects.''"<ref>http://expertiza.ncsu.edu/</ref> Students select from a list of tasks to be performed, with several students selecting each task. Then they prepare their work and submit it to an electronic peer-review system. The work is then reviewed by other students, who offer comments to help the submitters improve their work. The best submissions for each task are then selected for use in later courses. Expertiza gets students working together to improve others’ learning experiences. It helps them learn, by making them think through the lecture material and apply it to a real-world situation, just as they might do in an on-the-job situation. These learning objects can be improved iteratively; for example, the next year’s class can be presented with the examples developed by students the previous year, and asked to identify shortcomings and develop improved examples.<ref>http://scholar.google.com/scholar?q=%22Reusable+learning+objects+through+peer+review%3A+The+Expertiza+approach%22+%22The+Expertiza+platform+is+a+divide-and-conquer%22&btnG=&hl=en&as_sdt=0%2C34</ref> More information on Expertiza can be found [https://github.com/expertiza/expertiza here].

==Refactoring in Ruby==
Refactoring helps to<ref>http://www.refactoringinruby.com/</ref>
*Understand what led to poor code design
*Fix code which is difficult to understand
*Express each idea “once and only once”
*Recognize missing or inadequately formed classes
*Simplify overly complex relationships between classes
*Achieve the right balance of responsibilities among objects
*Make code easier to test and more maintainable

===Refactoring Techniques===
There are many documented refactoring techniques, and a few common ones are below.<ref>http://www.integralist.co.uk/posts/refactoring-techniques/</ref>
*'''Rename Method''': Renaming identifiers can reduce the need for code comments and nearly always helps to promote greater clarity.
*'''Introduce Explaining Variable''': So here is a technique specifically based around the premise of renaming.
For example:
<pre>
unless "This is a String with some CAPS".scan(/([A-Z])/).empty?
puts "capitalised text was found"
end
</pre>
Should be:
<pre>
caps_not_found = "This is a String with some CAPS".scan(/([A-Z])/).empty?

unless caps_not_found
puts "capitalised text was found"
end
</pre>

*'''Extract Method''': It consists of breaking up long methods by shifting overly complex chunks of code into new methods which have very descriptive identifiers.
For example:
<pre>
class Foo
attr_reader :bar

def initialize bar
@bar = bar
end

def do_something
puts "my baz" # notice this is duplication
puts bar
end

def do_something_else
puts "my baz" # notice this is duplication
puts "Something else"
puts bar
end
end
</pre>

Becomes:
<pre>
class Foo
attr_reader :bar

def initialize bar
@bar = bar
end

def do_something
baz
puts bar
end

def do_something_else
baz
puts "Something else"
puts bar
end

def baz
puts "my baz"
end
end
</pre>

*'''Inline Method''': Sometimes you want the opposite of the Extract Method technique. Imagine a method exists whose content is already simple and clear, and whose identifier adds no extra benefit. So to fix this problem we'll convert the method invocation into an inlined piece of code.

*'''Pull Up Method''': When you have duplicated code across two separate classes then the best refactoring technique to implement is to pull that duplicate code up into a super class so we DRY (Don't Repeat Yourself) out the code and allow it to be used in multiple places without duplication (meaning changes in future only have to happen in one place).

For example:
<pre>
class Person
attr_reader :first_name, :last_name

def initialize first_name, last_name
@first_name = first_name
@last_name = last_name
end

end

class MalePerson < Person
# This is duplicated in the `FemalePerson` class
def full_name
first_name + " " + last_name
end

def gender
"M"
end
end

class FemalePerson < Person
# This is duplicated in the `MalePerson` class
def full_name
first_name + " " + last_name
end

def gender
"F"
end
end
</pre>
Becomes:
<pre>
class Person
attr_reader :first_name, :last_name

def initialize first_name, last_name
@first_name = first_name
@last_name = last_name
end

def full_name
first_name + " " + last_name
end
end

class MalePerson < Person
def gender
"M"
end
end

class FemalePerson < Person
def gender
"F"
end
end
</pre>

*'''Introduce Named Parameter''':When method arguments are unclear then convert them into named parameters so they become clearer (and easier to remember).

==Project Description==

We were supposed to refactor two controllers, the ReportsController and the DynamicReviewMapping Controller. The ReportsController was thought to be generating reports for students, showing all their scores in a single page. The DynamicReviewMapping Controller is actually a helper to the ReviewMapping controller. The review mapping controller maps reviews to each user. Currently, there are two ways to assign reviews to user: The user can either select a submission himself, which he wants to review, or the site can suggest a review to the user. Currently, the user can give more than two reviews. The ReviewMapping controller had a method so that all the users are assigned reviews automatically. Originally, the plan was to assign only a fixed number of reviews to each user. The dynamic review controller helped the review mapping controller assign reviews so that the reviews are never mapped such that the last user does not have any review to map, except his own. For example, consider three users, U1, U2 and U3. If U1 is assigned U2's work and U2 is assigned U1's work, U3 would not have any work to review. The dynamic review mapping controller makes sure that such a condition does not occur.

We were supposed to refactor these controllers. The ReportsController did not have any known use, and the DynamicReviewMapping Controller had changes to be made to make it conform to standards.

==Modification to Existing Code==

===ReportsController===
After searching through various controllers, looking for references used in the controller, we figured out that the code in the ReportsController was actually copied from the ResponseController, in December 2013. The ResponseController has been refactored since, and thus is an updated version. As of the usage, only the ResponseController has been referenced, and the ReportsController had never been used. We also extracted an older version of the ReportsController, that is, the one before it was replaced with code from the ResponseController. The code had a single method, and the method did not have any useful functionality. It was, thus, decided that the ReportsController should be removed from the Expertiza project, and that removing it would not have any effect on the overall project. Keeping it in would, on the other hand, create confusion for other people who would work on the project later.

===DynamicReviewMapping Controller===
The changes to be made to the DynamicReviewController were small ones:
*changing if to unless where applicable
*change the “== true" and "== false" wherever applicable
*A code block was repeated 3 times through the file. We were supposed to refactor that to a function to make the code DRYer.
*Methods assign_metareviewers and assign_reviewers_team were too long. We were supposed to break them up for better readability.
*Method assign_reviewers_individual did not seem to be used. We were supposed to make sure, then delete the method if that was the case.

None of this would actually change the functionality of the code. To make sure, we tried to look for the usage of the code. Again, after extensive searching, we figured that the code was never used. The DynamicReviewMapping controller, as stated above, depended on a set of rules that were not applicable anymore. The controller exists so that it is available, in case the rules are reverted to the original one. As such, currently the Controller is not used. We made the changes, but we have no way to check the code. We did the best we could, and we are sure that there are no errors in the refactored code.

==Further Reading==
*[http://www.refactoringinruby.com/ Refactoring In Ruby]
*[http://refactoring.com/ Refactoring]

==References==
<references/><br>

CSC/ECE 517 Fall 2014/oss E1457 ags

2014-10-30T00:07:52Z

Sjshah: /* Modification to Existing Code */

=Expertiza - Refactoring DynamicReviewMapping Controller and the ReportsController=

__TOC__

==Introduction==
It is time consuming to assess project work in a large classroom environment, and one of the best techniques to achieve this is to have students assist in this assessment. If each student is asked to assess a few (say, one to five) other students or student teams, the task requires a reasonable amount of effort; and that effort does not increase as the class gets larger. "''Expertiza is a system for managing all kinds of communication that is involved in assessment: double-blind communications between authors and reviewers, assessment of teammate contributions, evaluations by course staff, and surveys of students to assess the assignment and the
peer-review process.''" <ref>http://www.igi-global.com/book/monitoring-assessment-online-collaborative-environments/773&f=e-book</ref>
''"Expertiza project uses peer review to create reusable learning objects.''"<ref>http://expertiza.ncsu.edu/</ref> Students select from a list of tasks to be performed, with several students selecting each task. Then they prepare their work and submit it to an electronic peer-review system. The work is then reviewed by other students, who offer comments to help the submitters improve their work. The best submissions for each task are then selected for use in later courses. Expertiza gets students working together to improve others’ learning experiences. It helps them learn, by making them think through the lecture material and apply it to a real-world situation, just as they might do in an on-the-job situation. These learning objects can be improved iteratively; for example, the next year’s class can be presented with the examples developed by students the previous year, and asked to identify shortcomings and develop improved examples.<ref>http://scholar.google.com/scholar?q=%22Reusable+learning+objects+through+peer+review%3A+The+Expertiza+approach%22+%22The+Expertiza+platform+is+a+divide-and-conquer%22&btnG=&hl=en&as_sdt=0%2C34</ref> More information on Expertiza can be found [https://github.com/expertiza/expertiza here].

==Refactoring in Ruby==
Refactoring helps to<ref>http://www.refactoringinruby.com/</ref>
*Understand what led to poor code design
*Fix code which is difficult to understand
*Express each idea “once and only once”
*Recognize missing or inadequately formed classes
*Simplify overly complex relationships between classes
*Achieve the right balance of responsibilities among objects
*Make code easier to test and more maintainable

===Refactoring Techniques===
There are many documented refactoring techniques, and a few common ones are below.<ref>http://www.integralist.co.uk/posts/refactoring-techniques/</ref>
*'''Rename Method''': Renaming identifiers can reduce the need for code comments and nearly always helps to promote greater clarity.
*'''Introduce Explaining Variable''': So here is a technique specifically based around the premise of renaming.
For example:
<pre>
unless "This is a String with some CAPS".scan(/([A-Z])/).empty?
puts "capitalised text was found"
end
</pre>
Should be:
<pre>
caps_not_found = "This is a String with some CAPS".scan(/([A-Z])/).empty?

unless caps_not_found
puts "capitalised text was found"
end
</pre>

*'''Extract Method''': It consists of breaking up long methods by shifting overly complex chunks of code into new methods which have very descriptive identifiers.
For example:
<pre>
class Foo
attr_reader :bar

def initialize bar
@bar = bar
end

def do_something
puts "my baz" # notice this is duplication
puts bar
end

def do_something_else
puts "my baz" # notice this is duplication
puts "Something else"
puts bar
end
end
</pre>

Becomes:
<pre>
class Foo
attr_reader :bar

def initialize bar
@bar = bar
end

def do_something
baz
puts bar
end

def do_something_else
baz
puts "Something else"
puts bar
end

def baz
puts "my baz"
end
end
</pre>

*'''Inline Method''': Sometimes you want the opposite of the Extract Method technique. Imagine a method exists whose content is already simple and clear, and whose identifier adds no extra benefit. So to fix this problem we'll convert the method invocation into an inlined piece of code.

*'''Pull Up Method''': When you have duplicated code across two separate classes then the best refactoring technique to implement is to pull that duplicate code up into a super class so we DRY (Don't Repeat Yourself) out the code and allow it to be used in multiple places without duplication (meaning changes in future only have to happen in one place).

For example:
<pre>
class Person
attr_reader :first_name, :last_name

def initialize first_name, last_name
@first_name = first_name
@last_name = last_name
end

end

class MalePerson < Person
# This is duplicated in the `FemalePerson` class
def full_name
first_name + " " + last_name
end

def gender
"M"
end
end

class FemalePerson < Person
# This is duplicated in the `MalePerson` class
def full_name
first_name + " " + last_name
end

def gender
"F"
end
end
</pre>
Becomes:
<pre>
class Person
attr_reader :first_name, :last_name

def initialize first_name, last_name
@first_name = first_name
@last_name = last_name
end

def full_name
first_name + " " + last_name
end
end

class MalePerson < Person
def gender
"M"
end
end

class FemalePerson < Person
def gender
"F"
end
end
</pre>

*'''Introduce Named Parameter''':When method arguments are unclear then convert them into named parameters so they become clearer (and easier to remember).

==Project Description==

We were supposed to refactor two controllers, the ReportsController and the DynamicReviewMapping Controller. The ReportsController was thought to be generating reports for students, showing all their scores in a single page. The DynamicReviewMapping Controller is actually a helper to the ReviewMapping controller. The review mapping controller maps reviews to each user. Currently, there are two ways to assign reviews to user: The user can either select a submission himself, which he wants to review, or the site can suggest a review to the user. Currently, the user can give more than two reviews. The ReviewMapping controller had a method so that all the users are assigned reviews automatically. Originally, the plan was to assign only a fixed number of reviews to each user. The dynamic review controller helped the review mapping controller assign reviews so that the reviews are never mapped such that the last user does not have any review to map, except his own. For example, consider three users, U1, U2 and U3. If U1 is assigned U2's work and U2 is assigned U1's work, U3 would not have any work to review. The dynamic review mapping controller makes sure that such a condition does not occur.

We were supposed to refactor these controllers. The ReportsController did not have any known use, and the DynamicReviewMapping Controller had changes to be made to make it conform to standards.

==Modification to Existing Code==

===ReportsController===
After searching through various controllers, looking for references used in the controller, we figured out that the code in the ReportsController was actually copied from the ResponseController, in December 2013. The ResponseController has been refactored since, and thus is an updated version. As of the usage, only the ResponseController has been referenced, and the ReportsController had never been used. We also extracted an older version of the ReportsController, that is, the one before it was replaced with code from the ResponseController. The code had a single method, and the method did not have any useful functionality. It was, thus, decided that the ReportsController should be removed from the Expertiza project, and that removing it would not have any effect on the overall project. Keeping it in would, on the other hand, create confusion for other people who would work on the project later.

===DynamicReviewMapping Controller===
The

==Further Reading==
*[http://www.refactoringinruby.com/ Refactoring In Ruby]
*[http://refactoring.com/ Refactoring]

==References==
<references/><br>

CSC/ECE 517 Fall 2014/oss E1457 ags

2014-10-29T23:58:48Z

Sjshah: /* Project Description */

=Expertiza - Refactoring DynamicReviewMapping Controller and the ReportsController=

__TOC__

==Introduction==
It is time consuming to assess project work in a large classroom environment, and one of the best techniques to achieve this is to have students assist in this assessment. If each student is asked to assess a few (say, one to five) other students or student teams, the task requires a reasonable amount of effort; and that effort does not increase as the class gets larger. "''Expertiza is a system for managing all kinds of communication that is involved in assessment: double-blind communications between authors and reviewers, assessment of teammate contributions, evaluations by course staff, and surveys of students to assess the assignment and the
peer-review process.''" <ref>http://www.igi-global.com/book/monitoring-assessment-online-collaborative-environments/773&f=e-book</ref>
''"Expertiza project uses peer review to create reusable learning objects.''"<ref>http://expertiza.ncsu.edu/</ref> Students select from a list of tasks to be performed, with several students selecting each task. Then they prepare their work and submit it to an electronic peer-review system. The work is then reviewed by other students, who offer comments to help the submitters improve their work. The best submissions for each task are then selected for use in later courses. Expertiza gets students working together to improve others’ learning experiences. It helps them learn, by making them think through the lecture material and apply it to a real-world situation, just as they might do in an on-the-job situation. These learning objects can be improved iteratively; for example, the next year’s class can be presented with the examples developed by students the previous year, and asked to identify shortcomings and develop improved examples.<ref>http://scholar.google.com/scholar?q=%22Reusable+learning+objects+through+peer+review%3A+The+Expertiza+approach%22+%22The+Expertiza+platform+is+a+divide-and-conquer%22&btnG=&hl=en&as_sdt=0%2C34</ref> More information on Expertiza can be found [https://github.com/expertiza/expertiza here].

==Refactoring in Ruby==
Refactoring helps to<ref>http://www.refactoringinruby.com/</ref>
*Understand what led to poor code design
*Fix code which is difficult to understand
*Express each idea “once and only once”
*Recognize missing or inadequately formed classes
*Simplify overly complex relationships between classes
*Achieve the right balance of responsibilities among objects
*Make code easier to test and more maintainable

===Refactoring Techniques===
There are many documented refactoring techniques, and a few common ones are below.<ref>http://www.integralist.co.uk/posts/refactoring-techniques/</ref>
*'''Rename Method''': Renaming identifiers can reduce the need for code comments and nearly always helps to promote greater clarity.
*'''Introduce Explaining Variable''': So here is a technique specifically based around the premise of renaming.
For example:
<pre>
unless "This is a String with some CAPS".scan(/([A-Z])/).empty?
puts "capitalised text was found"
end
</pre>
Should be:
<pre>
caps_not_found = "This is a String with some CAPS".scan(/([A-Z])/).empty?

unless caps_not_found
puts "capitalised text was found"
end
</pre>

*'''Extract Method''': It consists of breaking up long methods by shifting overly complex chunks of code into new methods which have very descriptive identifiers.
For example:
<pre>
class Foo
attr_reader :bar

def initialize bar
@bar = bar
end

def do_something
puts "my baz" # notice this is duplication
puts bar
end

def do_something_else
puts "my baz" # notice this is duplication
puts "Something else"
puts bar
end
end
</pre>

Becomes:
<pre>
class Foo
attr_reader :bar

def initialize bar
@bar = bar
end

def do_something
baz
puts bar
end

def do_something_else
baz
puts "Something else"
puts bar
end

def baz
puts "my baz"
end
end
</pre>

*'''Inline Method''': Sometimes you want the opposite of the Extract Method technique. Imagine a method exists whose content is already simple and clear, and whose identifier adds no extra benefit. So to fix this problem we'll convert the method invocation into an inlined piece of code.

*'''Pull Up Method''': When you have duplicated code across two separate classes then the best refactoring technique to implement is to pull that duplicate code up into a super class so we DRY (Don't Repeat Yourself) out the code and allow it to be used in multiple places without duplication (meaning changes in future only have to happen in one place).

For example:
<pre>
class Person
attr_reader :first_name, :last_name

def initialize first_name, last_name
@first_name = first_name
@last_name = last_name
end

end

class MalePerson < Person
# This is duplicated in the `FemalePerson` class
def full_name
first_name + " " + last_name
end

def gender
"M"
end
end

class FemalePerson < Person
# This is duplicated in the `MalePerson` class
def full_name
first_name + " " + last_name
end

def gender
"F"
end
end
</pre>
Becomes:
<pre>
class Person
attr_reader :first_name, :last_name

def initialize first_name, last_name
@first_name = first_name
@last_name = last_name
end

def full_name
first_name + " " + last_name
end
end

class MalePerson < Person
def gender
"M"
end
end

class FemalePerson < Person
def gender
"F"
end
end
</pre>

*'''Introduce Named Parameter''':When method arguments are unclear then convert them into named parameters so they become clearer (and easier to remember).

==Project Description==

We were supposed to refactor two controllers, the ReportsController and the DynamicReviewMapping Controller. The ReportsController was thought to be generating reports for students, showing all their scores in a single page. The DynamicReviewMapping Controller is actually a helper to the ReviewMapping controller. The review mapping controller maps reviews to each user. Currently, there are two ways to assign reviews to user: The user can either select a submission himself, which he wants to review, or the site can suggest a review to the user. Currently, the user can give more than two reviews. The ReviewMapping controller had a method so that all the users are assigned reviews automatically. Originally, the plan was to assign only a fixed number of reviews to each user. The dynamic review controller helped the review mapping controller assign reviews so that the reviews are never mapped such that the last user does not have any review to map, except his own. For example, consider three users, U1, U2 and U3. If U1 is assigned U2's work and U2 is assigned U1's work, U3 would not have any work to review. The dynamic review mapping controller makes sure that such a condition does not occur.

We were supposed to refactor these controllers. The ReportsController did not have any known use, and the DynamicReviewMapping Controller had changes to be made to make it conform to standards.

==Modification to Existing Code==

==Further Reading==
*[http://www.refactoringinruby.com/ Refactoring In Ruby]
*[http://refactoring.com/ Refactoring]

==References==
<references/><br>

CSC/ECE 517 Fall 2014/oss E1457 ags

2014-10-29T13:12:50Z

Sjshah: /* Expertiza - Refactoring DynamicReviewMapping Controller */

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-28T01:06:57Z

Sjshah:

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.<ref name="Link1">http://simply.liftweb.net/</ref>

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div><ref name="Book1">[http://www.manning.com/perrett/ Lift in action]</ref>

== More Information ==

=== Lift ===

==== Characteristics ====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

[[File:View_Lift.jpg]]

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

Lift runs on Scala. Scala runs on top of the JVM. This means that any and all of the java libraries and web containers can be used in running Lift applications. Java files can be used inside the project, such that Lift references the code used in a Java file, while Java can reference the code used in a Lift file

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

=== Scala ===

==== Introduction ====
[http://www.scala-lang.org/ Scala] stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development.
==== Features ====

Scala introduces some very powerful features designed to make the developer more productive. Some of the features are<ref name="Book" /> :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

===== Compatibility with Java<ref name = "ScalaSite">http://www.scala-lang.org/what-is-scala.html</ref> =====

Scala runs on the JVM. Java and Scala classes can be freely mixed, no matter whether they reside in different projects or in the same. They can even mutually refer to each other, the Scala compiler contains a subset of a Java compiler to make sense of such recursive dependencies. Java libraries, frameworks and tools are all available. Build tools like ant or maven, IDEs like Eclipse, IntelliJ, or Netbeans, frameworks like Spring or Hibernate all work seamlessly with Scala. Scala runs on all common JVMs and also on Android. The Scala community is an important part of the Java ecosystem. Popular Scala frameworks, including Akka, Finagle, and the Play web framework include dual APIs for Java and Scala.

===== Nature of the language =====
Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used. Programs written in Scala can be very concise and thus, are smaller in size than in most languages.

===== Future-Proof<ref name = "ScalaSite" /> =====
Scala particularly shines when it comes to scalable server software that makes use of concurrent and synchronous processing, parallel utilization of multiple cores, and distributed processing in the cloud.

Its functional nature makes it easier to write safe and performant multi-threaded code. There’s typically less reliance on mutable state and Scala’s futures and actors provide powerful tools for organizing concurrent system at a high-level of abstraction.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

File:View Lift.jpg

2014-09-14T20:09:33Z

Sjshah:

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T20:09:02Z

Sjshah: /* View First Approach */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Characteristics ====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

[[File:View_Lift.jpg]]

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

Lift runs on Scala. Scala runs on top of the JVM. This means that any and all of the java libraries and web containers can be used in running Lift applications. Java files can be used inside the project, such that Lift references the code used in a Java file, while Java can reference the code used in a Lift file

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

=== Scala ===

==== Introduction ====
[http://www.scala-lang.org/ Scala] stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development.
==== Features ====

Scala introduces some very powerful features designed to make the developer more productive. Some of the features are<ref name="Book" /> :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

===== Compatibility with Java<ref name = "ScalaSite">http://www.scala-lang.org/what-is-scala.html</ref> =====

Scala runs on the JVM. Java and Scala classes can be freely mixed, no matter whether they reside in different projects or in the same. They can even mutually refer to each other, the Scala compiler contains a subset of a Java compiler to make sense of such recursive dependencies. Java libraries, frameworks and tools are all available. Build tools like ant or maven, IDEs like Eclipse, IntelliJ, or Netbeans, frameworks like Spring or Hibernate all work seamlessly with Scala. Scala runs on all common JVMs and also on Android. The Scala community is an important part of the Java ecosystem. Popular Scala frameworks, including Akka, Finagle, and the Play web framework include dual APIs for Java and Scala.

===== Nature of the language =====
Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used. Programs written in Scala can be very concise and thus, are smaller in size than in most languages.

===== Future-Proof<ref name = "ScalaSite" /> =====
Scala particularly shines when it comes to scalable server software that makes use of concurrent and synchronous processing, parallel utilization of multiple cores, and distributed processing in the cloud.

Its functional nature makes it easier to write safe and performant multi-threaded code. There’s typically less reliance on mutable state and Scala’s futures and actors provide powerful tools for organizing concurrent system at a high-level of abstraction.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

File:View Lift.JPG

2014-09-14T20:08:13Z

Sjshah:

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:59:34Z

Sjshah: /* Nature of the language */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Characteristics ====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

Lift runs on Scala. Scala runs on top of the JVM. This means that any and all of the java libraries and web containers can be used in running Lift applications. Java files can be used inside the project, such that Lift references the code used in a Java file, while Java can reference the code used in a Lift file

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

=== Scala ===

==== Introduction ====
[http://www.scala-lang.org/ Scala] stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development.
==== Features ====

Scala introduces some very powerful features designed to make the developer more productive. Some of the features are<ref name="Book" /> :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

===== Compatibility with Java<ref name = "ScalaSite">http://www.scala-lang.org/what-is-scala.html</ref> =====

Scala runs on the JVM. Java and Scala classes can be freely mixed, no matter whether they reside in different projects or in the same. They can even mutually refer to each other, the Scala compiler contains a subset of a Java compiler to make sense of such recursive dependencies. Java libraries, frameworks and tools are all available. Build tools like ant or maven, IDEs like Eclipse, IntelliJ, or Netbeans, frameworks like Spring or Hibernate all work seamlessly with Scala. Scala runs on all common JVMs and also on Android. The Scala community is an important part of the Java ecosystem. Popular Scala frameworks, including Akka, Finagle, and the Play web framework include dual APIs for Java and Scala.

===== Nature of the language =====
Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used. Programs written in Scala can be very concise and thus, are smaller in size than in most languages.

===== Future-Proof<ref name = "ScalaSite" /> =====
Scala particularly shines when it comes to scalable server software that makes use of concurrent and synchronous processing, parallel utilization of multiple cores, and distributed processing in the cloud.

Its functional nature makes it easier to write safe and performant multi-threaded code. There’s typically less reliance on mutable state and Scala’s futures and actors provide powerful tools for organizing concurrent system at a high-level of abstraction.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:55:47Z

Sjshah: /* Features */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Characteristics ====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

Lift runs on Scala. Scala runs on top of the JVM. This means that any and all of the java libraries and web containers can be used in running Lift applications. Java files can be used inside the project, such that Lift references the code used in a Java file, while Java can reference the code used in a Lift file

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

=== Scala ===

==== Introduction ====
[http://www.scala-lang.org/ Scala] stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development.
==== Features ====

Scala introduces some very powerful features designed to make the developer more productive. Some of the features are<ref name="Book" /> :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

===== Compatibility with Java<ref name = "ScalaSite">http://www.scala-lang.org/what-is-scala.html</ref> =====

Scala runs on the JVM. Java and Scala classes can be freely mixed, no matter whether they reside in different projects or in the same. They can even mutually refer to each other, the Scala compiler contains a subset of a Java compiler to make sense of such recursive dependencies. Java libraries, frameworks and tools are all available. Build tools like ant or maven, IDEs like Eclipse, IntelliJ, or Netbeans, frameworks like Spring or Hibernate all work seamlessly with Scala. Scala runs on all common JVMs and also on Android. The Scala community is an important part of the Java ecosystem. Popular Scala frameworks, including Akka, Finagle, and the Play web framework include dual APIs for Java and Scala.

===== Nature of the language =====
Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used. Programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

http://www.google.com/imgres?imgurl=http%3A%2F%2Fmedia.dcentertainment.com%2Fsites%2Fdefault%2Ffiles%2FGalleryBatman75_1900x900_BM1_53333ef4f048e4.80983462.jpg&imgrefurl=http%3A%2F%2Fwww.dccomics.com%2Fcharacters%2Fbatman&h=900&w=1900&tbnid=zui8516AsW2c4M%3A&zoom=1&docid=m6J6QrzCuGXkRM&ei=i_IVVOjWL9fCsATQo4HYAw&tbm=isch&ved=0CCAQMygCMAI&iact=rc&uact=3&dur=0&page=1&start=0&ndsp=26
<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:54:57Z

Sjshah: /* Features */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Characteristics ====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

Lift runs on Scala. Scala runs on top of the JVM. This means that any and all of the java libraries and web containers can be used in running Lift applications. Java files can be used inside the project, such that Lift references the code used in a Java file, while Java can reference the code used in a Lift file

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

=== Scala ===

==== Introduction ====
[http://www.scala-lang.org/ Scala] stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development.
==== Features ====

Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

===== Compatibility with Java<ref name = "ScalaSite">http://www.scala-lang.org/what-is-scala.html</ref> =====

Scala runs on the JVM. Java and Scala classes can be freely mixed, no matter whether they reside in different projects or in the same. They can even mutually refer to each other, the Scala compiler contains a subset of a Java compiler to make sense of such recursive dependencies. Java libraries, frameworks and tools are all available. Build tools like ant or maven, IDEs like Eclipse, IntelliJ, or Netbeans, frameworks like Spring or Hibernate all work seamlessly with Scala. Scala runs on all common JVMs and also on Android. The Scala community is an important part of the Java ecosystem. Popular Scala frameworks, including Akka, Finagle, and the Play web framework include dual APIs for Java and Scala.

===== Nature of the language =====
Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used. Programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:54:27Z

Sjshah: /* Scala */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Characteristics ====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

Lift runs on Scala. Scala runs on top of the JVM. This means that any and all of the java libraries and web containers can be used in running Lift applications. Java files can be used inside the project, such that Lift references the code used in a Java file, while Java can reference the code used in a Lift file

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

=== Scala ===

==== Introduction ====
[http://www.scala-lang.org/ Scala] stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development.
==== Features ====

Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

===== Compatibility with Java ===== <ref name = "ScalaSite">http://www.scala-lang.org/what-is-scala.html</ref>

Scala runs on the JVM. Java and Scala classes can be freely mixed, no matter whether they reside in different projects or in the same. They can even mutually refer to each other, the Scala compiler contains a subset of a Java compiler to make sense of such recursive dependencies. Java libraries, frameworks and tools are all available. Build tools like ant or maven, IDEs like Eclipse, IntelliJ, or Netbeans, frameworks like Spring or Hibernate all work seamlessly with Scala. Scala runs on all common JVMs and also on Android. The Scala community is an important part of the Java ecosystem. Popular Scala frameworks, including Akka, Finagle, and the Play web framework include dual APIs for Java and Scala.

===== Nature of the language =====
Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used. Programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:49:02Z

Sjshah: /* Lift */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Characteristics ====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

Lift runs on Scala. Scala runs on top of the JVM. This means that any and all of the java libraries and web containers can be used in running Lift applications. Java files can be used inside the project, such that Lift references the code used in a Java file, while Java can reference the code used in a Lift file

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

=== Scala ===

==== Introduction ====

==== Features ====

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:48:46Z

Sjshah: /* Scala */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

=== Lift ===

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Characteristics ====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

Lift runs on Scala. Scala runs on top of the JVM. This means that any and all of the java libraries and web containers can be used in running Lift applications. Java files can be used inside the project, such that Lift references the code used in a Java file, while Java can reference the code used in a Lift file

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

=== Scala ===

==== Introduction ====

==== Features ====

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:47:39Z

Sjshah: /* Lift */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

=== Lift ===

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

=== Scala ===

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

[[File:http://wiki.expertiza.ncsu.edu/images/0/09/View_first.JPG]]

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Characteristics ====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

Lift runs on Scala. Scala runs on top of the JVM. This means that any and all of the java libraries and web containers can be used in running Lift applications. Java files can be used inside the project, such that Lift references the code used in a Java file, while Java can reference the code used in a Lift file

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

=== Scala ===

==== Introduction ====

==== Features ====

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:46:53Z

Sjshah: /* Support for Java */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

=== Lift ===

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. But, unlike Rails, it does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

As Lift is a framework for Scala and Scala is very compatible with Java, any and all of the java libraries and web containers can be used in running Lift applications.

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. It also provides native support for advanced web development techniques such as Comet and Ajax.

The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

=== Scala ===

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

[[File:http://wiki.expertiza.ncsu.edu/images/0/09/View_first.JPG]]

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Characteristics ====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

Lift runs on Scala. Scala runs on top of the JVM. This means that any and all of the java libraries and web containers can be used in running Lift applications. Java files can be used inside the project, such that Lift references the code used in a Java file, while Java can reference the code used in a Lift file

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

=== Scala ===

==== Introduction ====

==== Features ====

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:29:00Z

Sjshah: /* Lift */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

=== Lift ===

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. But, unlike Rails, it does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

As Lift is a framework for Scala and Scala is very compatible with Java, any and all of the java libraries and web containers can be used in running Lift applications.

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. It also provides native support for advanced web development techniques such as Comet and Ajax.

The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

=== Scala ===

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

[[File:http://wiki.expertiza.ncsu.edu/images/0/09/View_first.JPG]]

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Characteristics ====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

As Lift is a framework for Scala and Scala is very compatible with Java, any and all of the java libraries and web containers can be used in running Lift applications.

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

=== Scala ===

==== Introduction ====

==== Features ====

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:28:20Z

Sjshah: /* XML Processing Capabilities */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

=== Lift ===

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. But, unlike Rails, it does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

As Lift is a framework for Scala and Scala is very compatible with Java, any and all of the java libraries and web containers can be used in running Lift applications.

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. It also provides native support for advanced web development techniques such as Comet and Ajax.

The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

=== Scala ===

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

[[File:http://wiki.expertiza.ncsu.edu/images/0/09/View_first.JPG]]

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

===== Support for Java =====

As Lift is a framework for Scala and Scala is very compatible with Java, any and all of the java libraries and web containers can be used in running Lift applications.

===== Support for Advanced Features =====

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. Lift's powerful support for AJAX and Comet allows the developer to use Web 2.0 features with very little effort.

====== Comet ======
Lift leverages Scala's Actor library to provide a message-driven framework for Comet updates. In most cases, adding Comet support to a page just involves extending a trait to define the rendering method of the paage and adding an extra function call the links to dispatch the update message. Lift handles all of the backend and page-side coding to effect the Comet polling

====== AJAX ======

AJAX support includes special handlers for doing AJAX form submission via JSON, and almost any link function can easily be turned into an AJAX version with a few keystrokes. Lift has a class hierarchy for encapsulating JavaScript calls via direct JavaScript, jQuery or Yahoo User Interface library. The code can be generated automatically, reducing or eliminating the need to put JavaScript logic into the templates.

===== Other Characteristics =====
The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

=== Scala ===

==== Introduction ====

==== Features ====

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:19:41Z

Sjshah: /* View First Approach */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

=== Lift ===

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. But, unlike Rails, it does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

As Lift is a framework for Scala and Scala is very compatible with Java, any and all of the java libraries and web containers can be used in running Lift applications.

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. It also provides native support for advanced web development techniques such as Comet and Ajax.

The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

=== Scala ===

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket], to bind user-generated data into the presentation layer.

The View-First template means that the we start with an XML template, i.e., the view, and then embed, or execute, independent components to fill in the template. The benefit of this is that the page components become more modular, which makes modifying pages and reusing page components much simpler.

===== XML Processing Capabilities =====

Lift's templating is built on the XML processing capabilities of the scala language, and allows things such as:
* Nested templates
* Simple injection of user-generated content
* Advanced data capabilities.

Lift's advanced template and XML processing allows the developer to essentially write custom tag libraries at a very less cost in terms of time and effort.

The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

As Lift is a framework for Scala and Scala is very compatible with Java, any and all of the java libraries and web containers can be used in running Lift applications.

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. It also provides native support for advanced web development techniques such as Comet and Ajax.

The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

=== Scala ===

==== Introduction ====

==== Features ====

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:11:57Z

Sjshah: /* More Information */

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

=== Lift ===

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. But, unlike Rails, it does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

As Lift is a framework for Scala and Scala is very compatible with Java, any and all of the java libraries and web containers can be used in running Lift applications.

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. It also provides native support for advanced web development techniques such as Comet and Ajax.

The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

=== Scala ===

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Features ====

===== View First Approach =====
Lift does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. Lift takes the approach that there should be no code in the presentation layer, but it should be flexible enough to accommodate any conceivable uses. For this, Liift usess a powerful templating system, [http://wicket.apache.org Wicket]

The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

As Lift is a framework for Scala and Scala is very compatible with Java, any and all of the java libraries and web containers can be used in running Lift applications.

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. It also provides native support for advanced web development techniques such as Comet and Ajax.

The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

=== Scala ===

==== Introduction ====

==== Features ====

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Download Links</h3>
1. http://liftweb.net/download.html <br />
2. https://github.com/lift/framework <br />
3. http://scala-ide.org/docs/tutorials/lift24scalaide20/index.html <br />

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/ <br />
2. http://www.liftweb.net/ <br />
3. https://www.assembla.com/wiki/show/liftweb/Getting_Started <br />
4. http://hedleyproctor.com/2011/10/tutorial-building-your-first-lift-app-with-sbt/ <br />

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:04:54Z

Sjshah:

Lift is a web application framework designed for Scala Programming Language. It was designed by David Polka who was dissatisfied with Ruby on Rails. It was launched on February 26, in 2007 as an Open Source framework under the Apache 2.0 License.

== Background ==

=== Lift ===

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. But, unlike Rails, it does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

As Lift is a framework for Scala and Scala is very compatible with Java, any and all of the java libraries and web containers can be used in running Lift applications.

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. It also provides native support for advanced web development techniques such as Comet and Ajax.

The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

=== Scala ===

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Examples ==

<h3>Basic Scala</h3>

Skip this if you know Scala and how to use Lift.

Scala is an extremely flexible and feature-ful language, but you don't need to know much about it to get started with Lift. Read more about Scala some time, but here is all I think you need to know to get started if you already know Java or a similar language.

A Scala function definition looks like this:

''def [function-name] ([parameter-name]: [parameter-type]) : [return-type] = [function-body]''

so

''def taste (food: Consumable) : Opinion = evaluate(food)'' <br />

defines a function called taste that takes a Consumable as a parameter (food) and returns an Opinion
calls evaluate and returns the result, which must be an Opinion
<br />
The function body starts after the equals sign (=) and often starts on the same line
The last value is returned - no explicit return is required, but since the language is strongly typed there is protection against accidentally returning meaningless values of the wrong type
Now you can read Scala.

<h3> Java VS Scala </h3>

When building class definitions, it’s common to have to build so-called getter and setter methods in
order to set the values of that instance. This typically creates a lot of noise in the implementation (as
seen in the Java example that follows). Scala combats this by using the case modifier to automatically
provision standard functionality into the class definition. Given an instance of the Person case class,
calling person.name would return the name value.

<div>
{|class="wikitable" border="1" cellpadding="4" cellspacing="4"
| JAVA
| SCALA
|-
| public class Person {<br />
private int _age;<br />
private String _name;<br />
public Person(String n, int a){<br />
_age = a;<br />
_name = n;<br />
}<br />
String name(){ return _name; }<br />
int age(){ return _age; }<br />
}<br />
| case class Person(<br />
name: String, age: Int)
|}</div>

== More Information ==

=== Lift ===

==== Features ====

Lift is an expressive framework for building web applications using Scala. It borrows concept from Grails, Ruby on Rails, Seaside, Wicket and Django<ref name = "LiftWiki">[http://en.wikipedia.org/wiki/Lift_(web_framework) Lift (web framework), Wikipedia]</ref>. Lift is designed to make powerful techniques easily accessible, while keeping the overall framework simple and flexible.<ref name = "Book"> Derek Chen-Beccker et al. The Definitive Guide to Lift </ref>

Just like Rails, it favors convention over configuration: it decreases the number of decisions that developers need to make. But, unlike Rails, it does not follow the Model-View-Controller concept. It rather follows the "View First" approach, i.e., it focuses on what to display on the page rather than focusing on the programming of the objects and the logic that builds the page. The creators of Lift have cherry-picked the best ideas from a number of other frameworks, while adding some ideas on their own. Lift is intended to work out of the box and to make creating web pages as efficient and productive as possible<ref name="Book" />

As Lift is a framework for Scala and Scala is very compatible with Java, any and all of the java libraries and web containers can be used in running Lift applications.

Dynamic web content is authored into the web pages via templates using the standard HTML5 or XHTML editors. It also provides native support for advanced web development techniques such as Comet and Ajax.

The main characteristics of the Lift framework are:
* Resistant to common vulnerabilities
* Fast to build, concise and easy to maintain
* High performance and scale in the real world to handle big traffic levels
* Interactive like a desktop application

=== Scala ===

==== Introduction ====

==== Features ====

Scala stands for "Scalable Language". Scala is a relatively new language developed by Martin Odersky and his programming language research group at EPFL in Switzerland. The Scala programming language can be used for making general software application, or for web development. Scala is a pure-bred object-oriented language: Every value is an object, and every operation is a method call. The language is quite similar to Ruby.

The biggest difference between Ruby and Scala is that, Scala compiles to Java bytecode and runs on the Java Virtual Machine. Thus, it is possible to mix up Java and Scala. Both the languages can be used together for a single project; Scala code can refer the Java code and Java code can refer Scala code without any errors turning up. Scala introduces some very powerful features designed to make the developer more productive. Some of the features are :
* Extremely rich type system
* A powerful type inference
* Native XML processing
* Full support for closures and functions as objects
* Extensive high-level library

Scala is called "the statically typed dynamic language"<ref name = "Book"/>. It is possible to write code as quickly as with dynamically typed languages like Python, Ruby etc, but the language offers compile-time type safety like Java.

Scala is a also a hybrid functional and object-oriented language, which means one can get the power of the higher-level functional programming languages while retaining the modularity and reusability of OO components. The language uses very strong static type system and the compiler deciphers the types of the variables used.
Just like Ruby, programs written in Scala can be very concise and thus, are smaller in size than in most languages.

== Helpful Links ==

<h3>Lift Tutorials links</h3>
1. http://simply.liftweb.net/
2. http://www.liftweb.net/
3.

<h3>Helpful Links for Lift resources</h3>

{| class="wikitable sortable" border="1"
|-
! Resource
! Description
! Link
|-
| Main Lift site
| First and foremost is the main Lift homepage. Here you’ll find the latest
news about Lift, regularly updated as time goes by. This page also has
links to the source code, the issue tracker, and the wiki.
| http://liftweb.net
|-
| Assembla
| Lift moved to the Assembla platform for its wiki and bug-tracking requirements
some time ago, and since then it has accumulated a fair amount
of community-created articles.
| https://www.assembla.com/wiki/show/liftweb
|-
| Mailing list
| The Google group is the official support channel for Lift. If you have a
question, you can come to the mailing list and find a friendly, responsive
community that will be more than happy to answer your questions.
| http://groups.google.com/group/liftweb
|-
| IRC channel
| IRC isn’t as popular as it once was, but you’ll still find some of the Lift
team hanging out in IRC from time to time.
| https://www.freenode.net
|}

== References ==

<references />

CSC/ECE 517 Fall 2014/ch1a 4 lf

2014-09-14T19:03:50Z

Sjshah: