Expertiza_Wiki - User contributions [en]

E1740 - Lightweight Badging System based on Credly

2017-04-13T03:17:05Z

Aarivan: /* References */

This is the design review of our final project as part of CSC 517 in Spring 2017.
The Project is titled Lightweight badging system based on Credly.

===Purpose===

The purpose of this project is to implement several different “badges” that will be achievable for students by reaching a set of criteria. These badges will be “1st Submission”, “Dream Team”, and “Good Reviewer”. The images for the badges have previously been created, but must be re-worked to remove text that was too small to read. The logic for earning these badges must be implemented in Expertiza as well as how they display for both students and instructors.

=== Background ===

==== '''Expertizza''' ====
Expertiza project is a software to create reusable learning objects through peer review. It is an open source project based on Ruby on Rails framework. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages. It allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. The main goal of Expertiza as a whole is to have a platform for instructors to create or assign topics and students to submit their work related to the assigned topics.

==== '''Credly''' ====
Credly provides an universal way for people to earn and showcase their achievements and badges. We use Credly to design the badges. We are tasked with designing three badges - namely, Top Scores, Dream Team, and Good Reviewer. We store these badges as images for use in our project and can always add, remove or modify the existing badges in the future.

=== Requirements ===
The end goal of this project is to have the earned badges appear on the student’s task view as well as the instructor’s participants view. When the user hovers their cursor over an image a brief description of the badge will appear.

===Current Implementation===
The student’s task view appears as shown in the below screenshot, as per the current implementation. Students can see the list of tasks/assignments and the topics, grades and deadlines for each of those assignments.

[[File:before_1.jpg|center]]

The participants view in the current implementation (i.e, prior to the proposed changes). The instructors can see the list of students, their details, and the details related to that particular task.

[[File:after_1.jpg|center]]

===Proposed Implementation===
The student’s task view after our changes should appear as shown in the below screenshot, as per the current implementation. Students can see the badges earned along with the list of tasks/assignments and the topics, grades and deadlines for each of those assignments. Hovering over the badges would give you a brief description of the badge earned.

[[File:before_2.jpg|center]]

The participants view after the proposed implementation would be changed as shown below. The instructors can see the badges earned by the student next to the student's name along with the existing details.

[[File:after_2.jpg|center]]

===UML Diagram===
'''Use Case Diagram''':

[[File:e1740_use_case.jpg|center]]

===Use Case Description===
'''Use Case 1: First Submission Badge for Student'''

The student here will be able to view the first submission badge in their view (student_task/list) page, if the badge computer component in the system can determine the submission made by the team of the student is the first submission of the assignment.

'''Use Case 2: Dream Team Badge for Student'''

The student here will be able to view the dream team badge in their view (student_task/list) page, if the badge computer component in the system computes the aggregate scores of all the teammate reviews to be greater than 95.

'''Use Case 3: Good Reviewer Badge for Student'''

The student here will be able to view the good reviewer badge in their view (student_task/list) page, if the badge computer component in the system determines the review grade for the student to be greater than 95. Here, the system needs to wait for the grade score from the teaching staff to display this badge.

'''Use Case 4: First Submission Badge for Participants'''

The instructor here will be able to view the first submission badge for participants in their view (participants/list) page, if the badge computer component in the system can determine the submissions made by teams of each participants (in the list) are the first submissions of different assignments.

'''Use Case 5: Dream Team Badge for Participants'''

The instructor here will be able to view the dream team badge for participants in their view (student_task/list) page, if the badge computer component in the system computes the aggregate scores of all the teammate reviews for each participant to be greater than 95.

'''Use Case 6: Good Reviewer Badge for Participants'''

The instructor here will be able to view the good reviewer badge for participants in their view (student_task/list) page, if the badge computer component in the system determines the review grade for the each participant to be greater than 95. Here, the system needs to wait for the grade score from the teaching staff for each participant to display this badge.
===Proposed Design===

====Tasks to be completed====

To achieve the goal of this project we will work on four aspects.

'''TASK 1''' - creating the badge images and implementing them as a model in Expertiza
* This will involve using Credly to create the badges and,
* Making changes to student_task/list and participants/list to show them

'''TASK 2''' - Implement the 1st Submission badge
* To do this we will need to check the submission times of each assignment through the db teams table
* The team with the earliest submission time will have each member earn the 1st Submission badge
* The logic for this badge will be written in the team.rb file.

'''TASK 3''' - Implement the Dream Team badge
* This badge will be given to a team when all of their members receive an aggregate teammate review score of 95 or above
* To check for this, we will average the teammate review scores for each individual member and then check to see if each member had an average of 95 or above
* If the team accomplishes this, each member will be awarded the Dream Team badge
* If any member of the team does not have an average of 95 or above then none of the team members will be awarded the badge
* The logic for this badge will be written in the teammate_review_response_map.rb file

'''TASK 4''' - Implement the Good Reviewer badge
* This badge will be given to a student if they receive a review grade average of 95 or above from the teaching staff
* In order to calculate this score we will have to get each individual grade the student received on their reviews and average it out
* If that average is at 95 or above they will receive the badge, if not they will not be given this award
* The logic for this badge will be written in review_response_map.rb
On completing the tasks the badge system will be functional.

===Test Plan===

As verified with the instructor, the scope for testing in this project will be limited to majorly UI testing

==== Manual Testing ====
The following steps need to followed to test implementation manually.

1. Log in as an instructor and identify the top scorer for a particular assignment and later later impersonate the students of that team and make sure that all the team members have received the 'top score' badge.

2. Log in as an instructor and identify the team which received an average score greater than or equal to 95% and later later impersonate the students of that team and make sure that all the team members have received the 'dream team' badge.

3. Log in as an instructor and give review scores for two students (one more that 95% and one less than 95% for the other) and later later impersonate the students to make sure that the student who received more than 95% review grade received the 'good reviewer' badge and the other student does not.

4. Log in as an instructor and check if the students tested above has the badges reflected in the participant_list/list view page. The page shows all the assignment specific badges (Top score, Dream team and Good reviewer badge).

NOTE: The details about the badge should appear when we hover the mouse pointer above the badge

===Files to Change===
The following are a list of files that has been identified, which would be modified for the proposed implementation.

====Models====

#app/models/team.rb
#app/models/teammate_review_response_map.rb
#app/models/review_response_map.rb

====Views====

# app/views/participants/list.html.erb
# app/views/student_task/list.html.reb

====Controllers====

#app/controllers/participants_controller.rb
#app/controllers/student_task_controller.rb

===Important Links===

Link to Github repository : https://github.com/gokkulasudanr92/expertiza

===References===

#''http://www.ibm.com/developerworks/rational/library/769.html''
#''https://sourcemaking.com/design_patterns''
#''http://wiki.expertiza.ncsu.edu/index.php/Main_Page''

E1740 - Lightweight Badging System based on Credly

2017-04-12T22:43:27Z

Aarivan: /* UML Diagram */

This is the design review of our final project as part of CSC 517 in Spring 2017.
The Project is titled Lightweight badging system based on Credly.

===Purpose===

The purpose of this project is to implement several different “badges” that will be achievable for students by reaching a set of criteria. These badges will be “1st Submission”, “Dream Team”, and “Good Reviewer”. The images for the badges have previously been created, but must be re-worked to remove text that was too small to read. The logic for earning these badges must be implemented in Expertiza as well as how they display for both students and instructors.

=== Background ===

==== '''Expertizza''' ====
Expertiza project is a software to create reusable learning objects through peer review. It is an open source project based on Ruby on Rails framework. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages. It allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. The main goal of Expertiza as a whole is to have a platform for instructors to create or assign topics and students to submit their work related to the assigned topics.

==== '''Credly''' ====
Credly provides an universal way for people to earn and showcase their achievements and badges. We use Credly to design the badges. We are tasked with designing three badges - namely, Top Scores, Dream Team, and Good Reviewer. We store these badges as images for use in our project and can always add, remove or modify the existing badges in the future.

=== Requirements ===
The end goal of this project is to have the earned badges appear on the student’s task view as well as the instructor’s participants view. When the user hovers their cursor over an image a brief description of the badge will appear.

===Current Implementation===
The student’s task view appears as shown in the below screenshot, as per the current implementation. Students can see the list of tasks/assignments and the topics, grades and deadlines for each of those assignments.

<<---- INSERT IMG ---->>

The participants view in the current implementation (i.e, prior to the proposed changes). The instructors can see the list of students, their details, and the details related to that particular task.

<<---- INSERT IMG ---->>

===Proposed Implementation===
The student’s task view after our changes should appear as shown in the below screenshot, as per the current implementation. Students can see the badges earned along with the list of tasks/assignments and the topics, grades and deadlines for each of those assignments. Hovering over the badges would give you a brief description of the badge earned.

<<---- INSERT IMG ---->>

The participants view after the proposed implementation would be changed as shown below. The instructors can see the badges earned by the student next to the student's name along with the existing details.

<<---- INSERT IMG ---->>

===UML Diagram===

<<---- INSERT IMG ---->>

<<---- Brief description of the UML ---->>

===Proposed Design===

====Tasks to be completed====

To achieve the goal of this project we will work on four aspects.

'''TASK 1''' - creating the badge images and implementing them as a model in Expertiza
* This will involve using Credly to create the badges and,
* Making changes to student_task/list and participants/list to show them

'''TASK 2''' - Implement the 1st Submission badge
* To do this we will need to check the submission times of each assignment through the db teams table
* The team with the earliest submission time will have each member earn the 1st Submission badge
* The logic for this badge will be written in the team.rb file.

'''TASK 3''' - Implement the Dream Team badge
* This badge will be given to a team when all of their members receive an aggregate teammate review score of 95 or above
* To check for this, we will average the teammate review scores for each individual member and then check to see if each member had an average of 95 or above
* If the team accomplishes this, each member will be awarded the Dream Team badge
* If any member of the team does not have an average of 95 or above then none of the team members will be awarded the badge
* The logic for this badge will be written in the teammate_review_response_map.rb file

'''TASK 4''' - Implement the Good Reviewer badge
* This badge will be given to a student if they receive a review grade average of 95 or above from the teaching staff
* In order to calculate this score we will have to get each individual grade the student received on their reviews and average it out
* If that average is at 95 or above they will receive the badge, if not they will not be given this award
* The logic for this badge will be written in review_response_map.rb
On completing the tasks the badge system will be functional.

==== Design Pattern Used ====

<<---- BRIEF DESC ON THE DESIGN PATTERN USED ---->>

====Features to be added====

The badges are created in Credly and would be stored in app/assets/images/badges. The badges would called whenever a new

Added label or pop up which will indicate the metrics as icons, as shown below.
These icons will directly summarize the review in terms of predefined metrics. The reviews will be sorted according to the text metrics and will be displayed to the student on the 'Your Scores' page.

===Test Plan===

As verified with the instructor, the scope for testing in this project will be limited to majorly UI testing

==== Manual Testing ====
The following steps need to followed to test implementation manually.

1. Log in as an instructor and identify the top scorer for a particular assignment and later later impersonate the students of that team and make sure that all the team members have received the 'top score' badge.

2. Log in as an instructor and identify the team which received an average score greater than or equal to 95% and later later impersonate the students of that team and make sure that all the team members have received the 'dream team' badge.

3. Log in as an instructor and give review scores for two students (one more that 95% and one less than 95% for the other) and later later impersonate the students to make sure that the student who received more than 95% review grade received the 'good reviewer' badge and the other student does not.

4. Log in as an instructor and check if the students tested above has the badges reflected in the participant_list/list view page. The page shows all the assignment specific badges (Top score, Dream team and Good reviewer badge).

NOTE: The details about the badge should appear when we hover the mouse pointer above the badge

===Files Changed===
The following are a list of files that has been identified, which would be modified for the proposed implementation.

====Models====

#app/models/team.rb
#app/models/teammate_review_response_map.rb
#app/models/review_response_map.rb

====Views====

# app/views/participants/list.html.erb
# app/views/student_task/list.html.reb

====Controllers====

#app/controllers/participants_controller.rb
#app/controllers/student_task_controller.rb

===Important Links===

Link to Github repository :

Link to Pull request :

===References===

#''https://github.com/diasks2/ruby-nlp''
#''http://www.ibm.com/developerworks/rational/library/769.html''
#''https://sourcemaking.com/design_patterns''
#''http://wiki.expertiza.ncsu.edu/index.php/Main_Page''

E1740 - Lightweight Badging System based on Credly

2017-04-12T22:36:04Z

Aarivan: first draft

This is the design review of our final project as part of CSC 517 in Spring 2017.
The Project is titled Lightweight badging system based on Credly.

===Purpose===

The purpose of this project is to implement several different “badges” that will be achievable for students by reaching a set of criteria. These badges will be “1st Submission”, “Dream Team”, and “Good Reviewer”. The images for the badges have previously been created, but must be re-worked to remove text that was too small to read. The logic for earning these badges must be implemented in Expertiza as well as how they display for both students and instructors.

=== Background ===

==== '''Expertizza''' ====
Expertiza project is a software to create reusable learning objects through peer review. It is an open source project based on Ruby on Rails framework. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages. It allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. The main goal of Expertiza as a whole is to have a platform for instructors to create or assign topics and students to submit their work related to the assigned topics.

==== '''Credly''' ====
Credly provides an universal way for people to earn and showcase their achievements and badges. We use Credly to design the badges. We are tasked with designing three badges - namely, Top Scores, Dream Team, and Good Reviewer. We store these badges as images for use in our project and can always add, remove or modify the existing badges in the future.

=== Requirements ===
The end goal of this project is to have the earned badges appear on the student’s task view as well as the instructor’s participants view. When the user hovers their cursor over an image a brief description of the badge will appear.

===Current Implementation===
The student’s task view appears as shown in the below screenshot, as per the current implementation. Students can see the list of tasks/assignments and the topics, grades and deadlines for each of those assignments.

<<---- INSERT IMG ---->>

The participants view in the current implementation (i.e, prior to the proposed changes). The instructors can see the list of students, their details, and the details related to that particular task.

<<---- INSERT IMG ---->>

===Proposed Implementation===
The student’s task view after our changes should appear as shown in the below screenshot, as per the current implementation. Students can see the badges earned along with the list of tasks/assignments and the topics, grades and deadlines for each of those assignments. Hovering over the badges would give you a brief description of the badge earned.

<<---- INSERT IMG ---->>

The participants view after the proposed implementation would be changed as shown below. The instructors can see the badges earned by the student next to the student's name along with the existing details.

<<---- INSERT IMG ---->>

===UML Diagram===

<<---- INSERT IMG ---->>

Brief description of the UML

===Proposed Design===

====Tasks to be completed====

To achieve the goal of this project we will work on four aspects.

'''TASK 1''' - creating the badge images and implementing them as a model in Expertiza
* This will involve using Credly to create the badges and,
* Making changes to student_task/list and participants/list to show them

'''TASK 2''' - Implement the 1st Submission badge
* To do this we will need to check the submission times of each assignment through the db teams table
* The team with the earliest submission time will have each member earn the 1st Submission badge
* The logic for this badge will be written in the team.rb file.

'''TASK 3''' - Implement the Dream Team badge
* This badge will be given to a team when all of their members receive an aggregate teammate review score of 95 or above
* To check for this, we will average the teammate review scores for each individual member and then check to see if each member had an average of 95 or above
* If the team accomplishes this, each member will be awarded the Dream Team badge
* If any member of the team does not have an average of 95 or above then none of the team members will be awarded the badge
* The logic for this badge will be written in the teammate_review_response_map.rb file

'''TASK 4''' - Implement the Good Reviewer badge
* This badge will be given to a student if they receive a review grade average of 95 or above from the teaching staff
* In order to calculate this score we will have to get each individual grade the student received on their reviews and average it out
* If that average is at 95 or above they will receive the badge, if not they will not be given this award
* The logic for this badge will be written in review_response_map.rb
On completing the tasks the badge system will be functional.

==== Design Pattern Used ====

<<---- BRIEF DESC ON THE DESIGN PATTERN USED ---->>

====Features to be added====

The badges are created in Credly and would be stored in app/assets/images/badges. The badges would called whenever a new

Added label or pop up which will indicate the metrics as icons, as shown below.
These icons will directly summarize the review in terms of predefined metrics. The reviews will be sorted according to the text metrics and will be displayed to the student on the 'Your Scores' page.

===Test Plan===

As verified with the instructor, the scope for testing in this project will be limited to majorly UI testing

==== Manual Testing ====
The following steps need to followed to test implementation manually.

1. Log in as an instructor and identify the top scorer for a particular assignment and later later impersonate the students of that team and make sure that all the team members have received the 'top score' badge.

2. Log in as an instructor and identify the team which received an average score greater than or equal to 95% and later later impersonate the students of that team and make sure that all the team members have received the 'dream team' badge.

3. Log in as an instructor and give review scores for two students (one more that 95% and one less than 95% for the other) and later later impersonate the students to make sure that the student who received more than 95% review grade received the 'good reviewer' badge and the other student does not.

4. Log in as an instructor and check if the students tested above has the badges reflected in the participant_list/list view page. The page shows all the assignment specific badges (Top score, Dream team and Good reviewer badge).

NOTE: The details about the badge should appear when we hover the mouse pointer above the badge

===Files Changed===
The following are a list of files that has been identified, which would be modified for the proposed implementation.

====Models====

#app/models/team.rb
#app/models/teammate_review_response_map.rb
#app/models/review_response_map.rb

====Views====

# app/views/participants/list.html.erb
# app/views/student_task/list.html.reb

====Controllers====

#app/controllers/participants_controller.rb
#app/controllers/student_task_controller.rb

===Important Links===

Link to Github repository :

Link to Pull request :

===References===

#''https://github.com/diasks2/ruby-nlp''
#''http://www.ibm.com/developerworks/rational/library/769.html''
#''https://sourcemaking.com/design_patterns''
#''http://wiki.expertiza.ncsu.edu/index.php/Main_Page''

User:Aarivan

2017-04-12T22:34:47Z

Aarivan: moved User:Aarivan to E1726 - Remove Cache Field in Roles Table: final

#REDIRECT [[E1726 - Remove Cache Field in Roles Table]]

E1726 - Remove Cache Field in Roles Table

2017-04-12T22:34:47Z

Aarivan: moved User:Aarivan to E1726 - Remove Cache Field in Roles Table: final

== Introduction ==

=== Background ===
Expertiza is an open source web-based peer review system developed using Ruby on Rails. It is a dashboard containing all assignments for a particular course which is managed by the Professors and Teaching Assistants.

It eases the process of selecting assignment topics and choosing team-mates for the projects and greatly reduces the burden on the Professors and Teaching Assistants of assigning and managing teams for each assignment.

The main motive of this project is to make learning more effective through peer review. It allows students to review each other’s work and improve their work upon this feedback. It not only helps one improve their work but also provides a new way to learn.

Students upload or provide URLs of their work on expertiza which would be reviewed by the instructors and peers. Students later get to improve their work based on the reviews provided their peers.

== Problem statement : Remove cache field in roles table ==
The project requires us to remove the cache column from the roles table in database. Expertiza's 'roles' table has a 'cache' column, used by the superfish-rails gem to display different menus for different roles (super-administrator, administrator, instructor, teaching assistant, student, and unregistered user).

There is a Role model which makes use of the long text string data stored in the roles table under the cache column to load the menus (e.g., Users \n Questionnaires \n Courses …) for a particular role at the top of the page after login. Storing such long strings in databases is a bad idea because if we want to change that large text we are required to write a migration file which would be inconvenient and also there is a restriction on the number of characters allowed for long string datatype in MySQL.

== Design Plan ==
The Design plan followed here is as follows:
# Move the cache column value to YAML files for each role.
# Load the YAML value on environment/server startup.
# Use the corresponding YAML values for the corresponding role for the user logging in.
The reason for using this design is to have a pre-defined menu list for each roles. This gives more DRY principle for the application code, instead of going with the new object declaration every time the role model is needed.

== Tasks Identified ==
# Create YAML files containing the cache column data for each role from roles table in database.
## Create YAML files under 'config' folder named 'role_admin.yml' and put the 'cache' column value in it split across rails environment
## Create ruby script under 'config/initializers' folder named 'load_roles.rb' - to load the corresponding YAML values once the environment is set up
# Change the role.rb model to facilitate the use of above defined YAML files
# Remove the cache column from the roles table by migration
# Write rspec unit test for 'role.rb'

== Implementation ==

=== Created YAML files containing the cache column data for each role from roles table in database ===

===== Created YAML files under 'config' folder named 'role_admin.yml' and put the 'cache' column value in it split across rails environment =====
* 6 new files (role_admin.yml, role_instructor.yml, role_student.yml, role_super_admin.yml, role_ta.yml, role_unreg_user.yml) each corresponding to specific role are created
* Content of cache column from roles table are added for development, production and test environments
[[File:Role_admin.JPG|center]]

===== Created ruby script under 'config/initializers' folder named 'load_roles.rb' - to load the corresponding YAML values once the environment is set up =====
This code loads content of "/config/role_admin.yml" file and assigns to CACHED_ADMIN_MENU. Similarly, fields corresponding to different roles are populated from corresponding "/config/role_[ROLE]_.yml" file
[[File:load_roles.jpg|center]]

=== Changed the role.rb model to facilitate the use of above defined YAML files ===
Rebuid_credentials and rebuild_menu method are modified to load content from yml file. Here ApplicationHelper exposes get_cache_roles method to retrieve cache content corresponding to role id.
[[File:role-3.jpg|center]]
[[File:Application helper.jpg|center]]
In rebuild_cache method, role.save line is removed as cache field is not saved in database now.
Since cache field is removed from roles table, this field is added to role model using attr_accessible. It’s getter and setter are also created
[[File:role_4.jpg|center]]

=== Removed the cache column from the roles table by migration ===
Before removing cache column in roles table
[[File:Cache_col.png‎|center]]

Roles table after removing cache column
[[File:cache_after.jpg|center]]
Migration file to drop cache column
[[File:migrate.jpg|center]]

== Test Plan ==
The test plan followed here is done across 3 roles namely, student, administrator and instructor. The scenarios covered here are as follows:
# Check for the cache field and see if we get the expected value.
# Check if the role is valid role.
# Check for the cache field mismatch, that is, invalid cache field match.
The sections below points out the implementation steps taken to cover the test plan described above.

=== Manual Testing ===
# Login into Expertiza as one of the roles - super-admin or admin or student or instructor
# Check the menu tabs on the top and you can find the respective drop-downs according to the role logged in
# On clicking the option from the drop down you will be able to navigate to the respective pages
# This ensures that the code change done by us didn't break the code and it delivered it's expected functionality

=== Unit Tests ===
Unit tests have been written to check whether the modules work as it did earlier before. We have written rspec unit test for ‘role.rb’ which can be found here: ‘spec/models/role_spec.rb’ which tests 10 cases
# Evaluate the cache value with YAML values for student
# Evaluate the cache value with YAML values for instructor
# Evaluate the cache value with YAML values for admin
# Validation of name for student
# Validation of name for instructor
# Validation of name for admin
# Check the mismatch for cache values for the student in factories.rb
# Check the mismatch for cache values for the instructor in factories.rb
# Check the mismatch for cache values for the admin in factories.rb
# An invalid check for role object
[[File:rspec.jpg|center]]
[[File:rspec_result.jpg|center]]

=== Executing RSpec===
The steps required to execute the unit tests as an automated run:

1) cd into the expertiza directory

2) Run the command: rspec spec/models/role_spec.rb

== Scope for future improvement ==
There is a lot of scope for improvement for the current code. For instance, in the present situation, the YAML files have the database data corresponding to menu_items hard coded. We could define YAML file for menu_items table and load the menu_item YAML into the corresponding role YAML during environment setup. This would eradicate the use of menu_item table from the database.

E1726 - Remove Cache Field in Roles Table

2017-03-24T01:44:06Z

Aarivan:

== Introduction ==

=== Background ===
Expertiza is an open source web-based peer review system developed using Ruby on Rails. It is a dashboard containing all assignments for a particular course which is managed by the Professors and Teaching Assistants.

It eases the process of selecting assignment topics and choosing team-mates for the projects and greatly reduces the burden on the Professors and Teaching Assistants of assigning and managing teams for each assignment.

The main motive of this project is to make learning more effective through peer review. It allows students to review each other’s work and improve their work upon this feedback. It not only helps one improve their work but also provides a new way to learn.

Students upload or provide URLs of their work on expertiza which would be reviewed by the instructors and peers. Students later get to improve their work based on the reviews provided their peers.

== Problem statement : Remove cache field in roles table ==
The project requires us to remove the cache column from the roles table in database. Expertiza's 'roles' table has a 'cache' column, used by the superfish-rails gem to display different menus for different roles(super-administrator, administrator, instructor, teaching assistant, student, and unregistered user).

There is a Role model which makes use of the long text string data stored in the roles table under the cache column to load the menus (e.g., Users \n Questionnaires \n Courses …) for a particular role at the top of the page after login. Storing such long strings in databases is a bad idea because if we want to change that large text we are required to write a migration file which would be inconvenient and also there is a restriction on the number of characters allowed for long string datatype in MySQL.

We can resolve it by modifying the lines during cache attribute value assignment in the model. But the problem is that it will make the data used by different users inconsistent. We can work around this modification in an easy fashion, if we could store the large strings in the YAML files (one file for each role in the database)

== Tasks Identified ==
# Create YAML files containing the cache column data for each role from roles table in database.
## Create YAML files under 'config' folder named 'role_admin.yml' and put the 'cache' column value in it split across rails environment
## Create ruby script under 'config/initializers' folder named 'load_roles.rb' - to load the corresponding YAML values once the environment is set up
# Change the role.rb model to facilitate the use of above defined YAML files
# Remove the cache column from the roles table by migration
# Write rspec unit test for 'role.rb'

== Implementation ==

=== Created YAML files containing the cache column data for each role from roles table in database ===

===== Created YAML files under 'config' folder named 'role_admin.yml' and put the 'cache' column value in it split across rails environment =====
* 6 new files (role_admin.yml, role_instructor.yml, role_student.yml, role_super_admin.yml, role_ta.yml, role_unreg_user.yml) each corresponding to specific role are created
* Content of cache column from roles table are added for development, production and test environments
[[File:Role_admin.JPG|center]]

===== Created ruby script under 'config/initializers' folder named 'load_roles.rb' - to load the corresponding YAML values once the environment is set up =====
This code loads content of "/config/role_admin.yml" file and assigns to CACHED_ADMIN_MENU. Similarly, fields corresponding to different roles are populated from corresponding "/config/role_[ROLE]_.yml" file
[[File:load_roles.jpg|center]]

=== Changed the role.rb model to facilitate the use of above defined YAML files ===
Rebuid_credentials and rebuild_menu method are modified to load content from yml file. Here ApplicationHelper exposes get_cache_roles method to retrieve cache content corresponding to role id.
[[File:role-3.jpg|center]]
[[File:Application helper.jpg|center]]
In rebuild_cache method, role.save line is removed as cache field is not saved in database now.
Since cache field is removed from roles table, this field is added to role model using attr_accessible. It’s getter and setter are also created
[[File:role_4.jpg|center]]

=== Removed the cache column from the roles table by migration ===
Before removing cache column in roles table
[[File:Cache_col.png‎|center]]

Roles table after removing cache column
[[File:cache_after.jpg|center]]
Migration file to drop cache column
[[File:migrate.jpg|center]]

== Testing Details ==

=== UI Testing ===
# Login into Expertiza as one of the roles - super-admin or admin or student or instructor
# Check the menu tabs on the top and you can find the respective drop-downs according to the role logged in
# On clicking the option from the drop down you will be able to navigate to the respective pages
# This ensures that the code change done by us didn't break the code and it delivered it's expected functionality

=== Unit Testing ===
Unit tests have been written to check whether the modules work as it did earlier before. We have written rspec unit test for ‘role.rb’ which can be found here: ‘spec/models/role_spec.rb’ which tests 10 cases
# Evaluate the cache value with YAML values for student
# Evaluate the cache value with YAML values for instructor
# Evaluate the cache value with YAML values for admin
# Validation of name for student
# Validation of name for instructor
# Validation of name for admin
# Check the mismatch for cache values for the student in factories.rb
# Check the mismatch for cache values for the instructor in factories.rb
# Check the mismatch for cache values for the admin in factories.rb
# An invalid check for role object
[[File:rspec.jpg|center]]
[[File:rspec_result.jpg|center]]

== Scope for future improvement ==
There is a lot of scope for improvement for the current code. For instance, in the present situation, the YAML files have the database data corresponding to menu_items hard coded. We could define YAML file for menu_items table and load the menu_item YAML into the corresponding role YAML during environment setup. This would eradicate the use of menu_item table from the database.

File:Role 4.jpg

2017-03-24T01:43:48Z

Aarivan:

File:Role-3.jpg

2017-03-24T01:43:30Z

Aarivan:

E1726 - Remove Cache Field in Roles Table

2017-03-24T01:18:44Z

Aarivan:

== Introduction ==

=== Background ===
Expertiza is an open source web-based peer review system developed using Ruby on Rails. It is a dashboard containing all assignments for a particular course which is managed by the Professors and Teaching Assistants.

It eases the process of selecting assignment topics and choosing team-mates for the projects and greatly reduces the burden on the Professors and Teaching Assistants of assigning and managing teams for each assignment.

The main motive of this project is to make learning more effective through peer review. It allows students to review each other’s work and improve their work upon this feedback. It not only helps one improve their work but also provides a new way to learn.

Students upload or provide URLs of their work on expertiza which would be reviewed by the instructors and peers. Students later get to improve their work based on the reviews provided their peers.

== Problem statement : Remove cache field in roles table ==
The project requires us to remove the cache column from the roles table in database. Expertiza's 'roles' table has a 'cache' column, used by the superfish-rails gem to display different menus for different roles(super-administrator, administrator, instructor, teaching assistant, student, and unregistered user).

There is a Role model which makes use of the long text string data stored in the roles table under the cache column to load the menus (e.g., Users \n Questionnaires \n Courses …) for a particular role at the top of the page after login. Storing such long strings in databases is a bad idea because if we want to change that large text we are required to write a migration file which would be inconvenient and also there is a restriction on the number of characters allowed for long string datatype in MySQL.

We can resolve it by modifying the lines during cache attribute value assignment in the model. But the problem is that it will make the data used by different users inconsistent. We can work around this modification in an easy fashion, if we could store the large strings in the YAML files (one file for each role in the database)

== Tasks Identified ==
# Create YAML files containing the cache column data for each role from roles table in database.
## Create YAML files under 'config' folder named 'role_admin.yml' and put the 'cache' column value in it split across rails environment
## Create ruby script under 'config/initializers' folder named 'load_roles.rb' - to load the corresponding YAML values once the environment is set up
# Change the role.rb model to facilitate the use of above defined YAML files
# Remove the cache column from the roles table by migration
# Write rspec unit test for 'role.rb'

== Implementation ==

=== Created YAML files containing the cache column data for each role from roles table in database ===

===== Created YAML files under 'config' folder named 'role_admin.yml' and put the 'cache' column value in it split across rails environment =====
* 6 new files (role_admin.yml, role_instructor.yml, role_student.yml, role_super_admin.yml, role_ta.yml, role_unreg_user.yml) each corresponding to specific role are created
* Content of cache column from roles table are added for development, production and test environments
[[File:Role_admin.JPG|center]]

===== Created ruby script under 'config/initializers' folder named 'load_roles.rb' - to load the corresponding YAML values once the environment is set up =====
This code loads content of "/config/role_admin.yml" file and assigns to CACHED_ADMIN_MENU. Similarly, fields corresponding to different roles are populated from corresponding "/config/role_[ROLE]_.yml" file
[[File:load_roles.jpg|center]]

=== Changed the role.rb model to facilitate the use of above defined YAML files ===
Rebuid_credentials and rebuild_menu method are modified to load content from yml file. Here ApplicationHelper exposes get_cache_roles method to retrieve cache content corresponding to role id.
[[File:Role 2.jpg|center]]
[[File:Application helper.jpg|center]]
In rebuild_cache method, role.save line is removed as cache field is not saved in database now.
Since cache field is removed from roles table, this field is added to role model using attr_accessible. It’s getter and setter are also created
[[File:Role.jpg|center]]

=== Removed the cache column from the roles table by migration ===
Before removing cache column in roles table
[[File:cache_col.jpg|center]]
Migration file to drop cache column

Roles table after removing cache column
[[File:cache_after.jpg|center]]
Migration file is created to remove cache column from roles table
[[File:migrate.jpg|center]]

== Testing Details ==

=== UI Testing ===
# Login into Expertiza as one of the roles - super-admin or admin or student or instructor
# Check the menu tabs on the top and you can find the respective drop-downs according to the role logged in
# On clicking the option from the drop down you will be able to navigate to the respective pages
# This ensures that the code change done by us didn't break the code and it delivered it's expected functionality

=== Unit Testing ===
Unit tests have been written to check whether the modules work as it did earlier before. We have written rspec unit test for ‘role.rb’ which can be found here: ‘spec/models/role_spec.rb’ which tests 10 cases
# Evaluate the cache value with YAML values for student
# Evaluate the cache value with YAML values for instructor
# Evaluate the cache value with YAML values for admin
# Validation of name for student
# Validation of name for instructor
# Validation of name for admin
# Check the mismatch for cache values for the student in factories.rb
# Check the mismatch for cache values for the instructor in factories.rb
# Check the mismatch for cache values for the admin in factories.rb
# An invalid check for role object
[[File:rspec.jpg|center]]
[[File:rspec_result.jpg|center]]

== Scope for future improvement ==
There is a lot of scope for improvement for the current code. For instance, in the present situation, the YAML files have the database data corresponding to menu_items hard coded. We could define YAML file for menu_items table and load the menu_item YAML into the corresponding role YAML during environment setup. This would eradicate the use of menu_item table from the database.

File:Rspec result.jpg

2017-03-24T01:18:25Z

Aarivan:

File:Rspec.jpg

2017-03-24T01:18:12Z

Aarivan:

E1726 - Remove Cache Field in Roles Table

2017-03-24T01:03:29Z

Aarivan:

== Introduction ==

=== Background ===
Expertiza is an open source web-based peer review system developed using Ruby on Rails. It is a dashboard containing all assignments for a particular course which is managed by the Professors and Teaching Assistants.

It eases the process of selecting assignment topics and choosing team-mates for the projects and greatly reduces the burden on the Professors and Teaching Assistants of assigning and managing teams for each assignment.

The main motive of this project is to make learning more effective through peer review. It allows students to review each other’s work and improve their work upon this feedback. It not only helps one improve their work but also provides a new way to learn.

Students upload or provide URLs of their work on expertiza which would be reviewed by the instructors and peers. Students later get to improve their work based on the reviews provided their peers.

== Problem statement : Remove cache field in roles table ==
The project requires us to remove the cache column from the roles table in database. Expertiza's 'roles' table has a 'cache' column, used by the superfish-rails gem to display different menus for different roles(super-administrator, administrator, instructor, teaching assistant, student, and unregistered user).

There is a Role model which makes use of the long text string data stored in the roles table under the cache column to load the menus (e.g., Users \n Questionnaires \n Courses …) for a particular role at the top of the page after login. Storing such long strings in databases is a bad idea because if we want to change that large text we are required to write a migration file which would be inconvenient and also there is a restriction on the number of characters allowed for long string datatype in MySQL.

We can resolve it by modifying the lines during cache attribute value assignment in the model. But the problem is that it will make the data used by different users inconsistent. We can work around this modification in an easy fashion, if we could store the large strings in the YAML files (one file for each role in the database)

== Tasks Identified ==
# Create YAML files containing the cache column data for each role from roles table in database.
## Create YAML files under 'config' folder named 'role_admin.yml' and put the 'cache' column value in it split across rails environment
## Create ruby script under 'config/initializers' folder named 'load_roles.rb' - to load the corresponding YAML values once the environment is set up
# Change the role.rb model to facilitate the use of above defined YAML files
# Remove the cache column from the roles table by migration
# Write rspec unit test for 'role.rb'

== Implementation ==

=== Created YAML files containing the cache column data for each role from roles table in database ===

===== Created YAML files under 'config' folder named 'role_admin.yml' and put the 'cache' column value in it split across rails environment =====
* 6 new files (role_admin.yml, role_instructor.yml, role_student.yml, role_super_admin.yml, role_ta.yml, role_unreg_user.yml) each corresponding to specific role are created
* Content of cache column from roles table are added for development, production and test environments
[[File:Role_admin.JPG|center]]

===== Created ruby script under 'config/initializers' folder named 'load_roles.rb' - to load the corresponding YAML values once the environment is set up =====
This code loads content of "/config/role_admin.yml" file and assigns to CACHED_ADMIN_MENU. Similarly, fields corresponding to different roles are populated from corresponding "/config/role_[ROLE]_.yml" file
[[File:load_roles.jpg|center]]

=== Changed the role.rb model to facilitate the use of above defined YAML files ===
Rebuid_credentials and rebuild_menu method are modified to load content from yml file. Here ApplicationHelper exposes get_cache_roles method to retrieve cache content corresponding to role id.
[[File:Role 2.jpg|center]]

In rebuild_cache method, role.save line is removed as cache field is not saved in database now.
Since cache field is removed from roles table, this field is added to role model using attr_accessible. It’s getter and setter are also created
[[File:Role.jpg|center]]

=== Removed the cache column from the roles table by migration ===
Before removing cache column in roles table
[[File:cache_col.jpg|center]]
Migration file to drop cache column

Roles table after removing cache column
[[File:cache_after.jpg|center]]
Migration file is created to remove cache column from roles table
[[File:migrate.jpg|center]]

== Testing Details ==

=== UI Testing ===
# Login into Expertiza as one of the roles - super-admin or admin or student or instructor
# Check the menu tabs on the top and you can find the respective drop-downs according to the role logged in
# On clicking the option from the drop down you will be able to navigate to the respective pages
# This ensures that the code change done by us didn't break the code and it delivered it's expected functionality

=== Unit Testing ===
Unit tests have been written to check whether the modules work as it did earlier before. We have written rspec unit test for ‘role.rb’ which can be found here: ‘spec/models/role_spec.rb’ which tests 10 cases
# Evaluate the cache value with YAML values for student
# Evaluate the cache value with YAML values for instructor
# Evaluate the cache value with YAML values for admin
# Validation of name for student
# Validation of name for instructor
# Validation of name for admin
# Check the mismatch for cache values for the student in factories.rb
# Check the mismatch for cache values for the instructor in factories.rb
# Check the mismatch for cache values for the admin in factories.rb
# An invalid check for role object

== Scope for future improvement ==
There is a lot of scope for improvement for the current code. For instance, in the present situation, the YAML files have the database data corresponding to menu_items hard coded. We could define YAML file for menu_items table and load the menu_item YAML into the corresponding role YAML during environment setup. This would eradicate the use of menu_item table from the database.

File:Migrate.jpg

2017-03-24T01:03:06Z

Aarivan:

File:Cache after.jpg

2017-03-24T00:54:46Z

Aarivan:

File:Role 2.jpg

2017-03-24T00:18:11Z

Aarivan:

File:Role.jpg

2017-03-24T00:15:26Z

Aarivan: uploaded a new version of "File:Role.jpg"

File:Role.jpg

2017-03-24T00:14:24Z

Aarivan: uploaded a new version of "File:Role.jpg"

File:Role.jpg

2017-03-24T00:13:49Z

Aarivan: uploaded a new version of "File:Role.jpg"

File:Role.jpg

2017-03-24T00:13:27Z

Aarivan:

File:Application helper.jpg

2017-03-24T00:09:37Z

Aarivan:

File:Load roles.jpg

2017-03-23T23:28:41Z

Aarivan:

File:Role admin.JPG

2017-03-23T23:21:22Z

Aarivan:

E1726 - Remove Cache Field in Roles Table

2017-03-23T01:39:13Z

Aarivan: First draft

== Introduction ==

=== Background ===
Expertiza is an open source web-based peer review system developed using Ruby on Rails. It is a dashboard containing all assignments for a particular course which is managed by the Professors and Teaching Assistants.

It eases the process of selecting assignment topics and choosing team-mates for the projects and greatly reduces the burden on the Professors and Teaching Assistants of assigning and managing teams for each assignment.

The main motive of this project is to make learning more effective through peer review. It allows students to review each other’s work and improve their work upon this feedback. It not only helps one improve their work but also provides a new way to learn.

Students upload or provide URLs of their work on expertiza which would be reviewed by the instructors and peers. Students later get to improve their work based on the reviews provided their peers.

== Problem statement : Remove cache field in roles table ==
The project requires us to remove the cache column from the roles table in database. Expertiza's 'roles' table has a 'cache' column, used by the superfish-rails gem to display different menus for different roles(super-administrator, administrator, instructor, teaching assistant, student, and unregistered user).

There is a Role model which makes use of the long text string data stored in the roles table under the cache column to load the menus (e.g., Users \n Questionnaires \n Courses …) for a particular role at the top of the page after login. Storing such long strings in databases is a bad idea because if we want to change that large text we are required to write a migration file which would be inconvenient and also there is a restriction on the number of characters allowed for long string datatype in MySQL.

We can resolve it by modifying the lines during cache attribute value assignment in the model. But the problem is that it will make the data used by different users inconsistent. We can work around this modification in an easy fashion, if we could store the large strings in the YAML files (one file for each role in the database)

== Tasks Identified ==
# Create YAML files containing the cache column data for each role from roles table in database.
## Create YAML files under 'config' folder named 'role_admin.yml' and put the 'cache' column value in it split across rails environment
## Create ruby script under 'config/initializers' folder named 'load_roles.rb' - to load the corresponding YAML values once the environment is set up
# Change the role.rb model to facilitate the use of above defined YAML files
# Remove the cache column from the roles table by migration
# Write rspec unit test for 'role.rb'

== Implementation ==

=== Created YAML files containing the cache column data for each role from roles table in database ===

===== Created YAML files under 'config' folder named 'role_admin.yml' and put the 'cache' column value in it split across rails environment =====
* 6 new files (role_admin.yml, role_instructor.yml, role_student.yml, role_super_admin.yml, role_ta.yml, role_unreg_user.yml) each corresponding to specific role are created
* Content of cache column from roles table are added for development, production and test environments

===== Created ruby script under 'config/initializers' folder named 'load_roles.rb' - to load the corresponding YAML values once the environment is set up =====
This code loads content of "/config/role_admin.yml" file and assigns to CACHED_ADMIN_MENU. Similarly, fields corresponding to different roles are populated from corresponding "/config/role_[ROLE]_.yml" file

=== Changed the role.rb model to facilitate the use of above defined YAML files ===
Rebuid_credentials and rebuild_menu method are modified to load content from yml file. Here ApplicationController exposes get_cache_roles method to retrieve cache content corresponding to role id.

In rebuild_cache method, role.save line is removed as cache field is not saved in database now.

Since cache field is removed from roles table, this field is added to role model using attr_accessible. It’s getter and setter are also created

=== Removed the cache column from the roles table by migration ===
Before removing cache column in roles table

Migration file to drop cache column

Roles table after removing cache column

Migration file is created to remove cache column from roles table

== Testing Details ==

=== UI Testing ===
# Login into Expertiza as one of the roles - super-admin or admin or student or instructor
# Check the menu tabs on the top and you can find the respective drop-downs according to the role logged in
# On clicking the option from the drop down you will be able to navigate to the respective pages
# This ensures that the code change done by us didn't break the code and it delivered it's expected functionality

=== Unit Testing ===
Unit tests have been written to check whether the modules work as it did earlier before. We have written rspec unit test for ‘role.rb’ which can be found here: ‘spec/models/role_spec.rb’ which tests 10 cases
# Evaluate the cache value with YAML values for student
# Evaluate the cache value with YAML values for instructor
# Evaluate the cache value with YAML values for admin
# Validation of name for student
# Validation of name for instructor
# Validation of name for admin
# Check the mismatch for cache values for the student in factories.rb
# Check the mismatch for cache values for the instructor in factories.rb
# Check the mismatch for cache values for the admin in factories.rb
# An invalid check for role object

== Scope for future improvement ==
There is a lot of scope for improvement for the current code. For instance, in the present situation, the YAML files have the database data corresponding to menu_items hard coded. We could define YAML file for menu_items table and load the menu_item YAML into the corresponding role YAML during environment setup. This would eradicate the use of menu_item table from the database.

E1726 - Remove Cache Field in Roles Table

2017-03-23T00:53:32Z

Aarivan: Created page with "Introduction Background Expertiza is an open source web-based peer review system developed using Ruby on Rails. It is a dashboard containing all assignments for a particular co..."

Introduction
Background

Expertiza is an open source web-based peer review system developed using Ruby on Rails. It is a dashboard containing all assignments for a particular course which is managed by the Professors and Teaching Assistants.

It eases the process of selecting assignment topics and choosing team-mates for the projects.

It greatly reduces the burden on the Professors and Teaching Assistants of assigning and managing teams for each assignment.

The main motive of this project is to make learning more effective through peer review. It allows students to review each other’s work and improve their work upon this feedback. This helps in improving the existing work and also provides a new way to learn.

Students upload or provide URLs of their work on expertiza which would be reviewed by the instructors and peers. Students later get to improve their work based on the reviews provided their peers.