Expertiza_Wiki - User contributions [en]

Documentation for Database Anonymization

2023-03-13T07:54:20Z

Rsshives:

We use Database Anonymization to scrub the database and replace real-time Expertiza records with fake data to use it for development purposes and to avoid hamper the integrity of users' data while development.

==Initial Setup for Anonymization==
We use the <code>faker</code> gem to create fake names and replace the actual data with the names generated by this gem.

In the <code>Gemfile</code> add
<pre>
gem 'faker', '1.9.3', group: [:test, :development], require: false
</pre>

In <code>config/locales</code>, change <code>en-US.yml</code> to <code>en.yml</code>

Inside the file, replace <code>en-US:</code> to <code>en:</code>
(This is to avoid any translation error thrown by i18n)

Have a database <code>expertiza_development</code> with real-time records of the expertiza database

==Anonymization Script==

===Rake task to run the script===
In <code>lib/tasks/scrub_database.rake</code> we have defined a namespace <code>db</code> inside which we have a task <code>scrub</code>

<pre>
namespace :db do
namespace :data do
desc 'Scrubs the database of user information'
task scrub: :environment do
require './db/data_migrations/scrub_database.rb' # Require the data migration class
ScrubDatabase.run! # Run the function which contains the logic
end
end
end
</pre>

===Logic of the script===
In <code>db/data_migrations/scrub_database.rb</code> we have the main logic to anonymize the script

<pre>
require 'i18n'
require 'faker'

class ScrubDatabase
I18n.default_locale = :en # here, we set the default locale to be used
I18n.reload!
def self.run! # this is the function called in the rake file
User.find_each do |user|
#logic for anonymizing the records
end
end
end
</pre>

===Format for anonymizing===

For Students:
<pre>
user.name = "<fname>_<lname_subS><num>"
user.fullname = "<lname>, <fname>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

For Others:
<pre>
user.name = "<role>_<fname>_<lname_subS><num>"
user.fullname = "<fname>, <role>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

where

<code>fname</code> : First name generated by Faker gem

<code>lname</code> : Last name generated by Faker gem

<code>lname_subS</code> : Substring of Last name of first 4 characters

<code>role</code> : Role of actual user (eg. teaching_assistant, instructor)

<code>num</code> : A random number generated between 1 to 9

==Running the anonymization script==
This script anonymizes the records present in the <code>expertiza_development</code> database

To run this script, you have to switch to sudo user with the command <code>sudo su</code>
<pre>
cd lib/tasks
</pre>

<pre>
rake db:data:scrub --trace
</pre>

After the task is completed, login to mysql
<pre>
mysql -u root -p
use expertiza_development;
select name, fullname, email from users limit 10;
</pre>

To check for any duplicate entries, run this SQL command

<pre>
select name, count(name) from users group by name having count(name) >1;
</pre>

'''*Note down the names, and add them to the blacklist, since we would not be able to login to these accounts
'''

'''*Ensure there are no more than 8 duplicate entries of students and none of other roles. Otherwise re-run the script
'''

Documentation for Database Anonymization

2023-03-13T07:53:29Z

Rsshives:

We use Database Anonymization to scrub the database and replace real-time Expertiza records with fake data to use it for development purposes and to avoid hamper the integrity of users' data while development.

==Initial Setup for Anonymization==
We use the <code>faker</code> gem to create fake names and replace the actual data with the names generated by this gem.

In the <code>Gemfile</code> add
<pre>
gem 'faker', '1.9.3', group: [:test, :development], require: false
</pre>

In config/locales, change <code>en-US.yml</code> to <code>en.yml</code>

Inside the file, replace <code>en-US:</code> to <code>en:</code>
(This is to avoid any translation error thrown by i18n)

Have a database <code>expertiza_development</code> with real-time records of the expertiza database

==Anonymization Script==

===Rake task to run the script===
In <code>lib/tasks/scrub_database.rake</code> we have defined a namespace <code>db</code> inside which we have a task <code>scrub</code>

<pre>
namespace :db do
namespace :data do
desc 'Scrubs the database of user information'
task scrub: :environment do
require './db/data_migrations/scrub_database.rb' # Require the data migration class
ScrubDatabase.run! # Run the function which contains the logic
end
end
end
</pre>

===Logic of the script===
In <code>db/data_migrations/scrub_database.rb</code> we have the main logic to anonymize the script

<pre>
require 'i18n'
require 'faker'

class ScrubDatabase
I18n.default_locale = :en # here, we set the default locale to be used
I18n.reload!
def self.run! # this is the function called in the rake file
User.find_each do |user|
#logic for anonymizing the records
end
end
end
</pre>

===Format for anonymizing===

For Students:
<pre>
user.name = "<fname>_<lname_subS><num>"
user.fullname = "<lname>, <fname>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

For Others:
<pre>
user.name = "<role>_<fname>_<lname_subS><num>"
user.fullname = "<fname>, <role>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

where

<code>fname</code> : First name generated by Faker gem

<code>lname</code> : Last name generated by Faker gem

<code>lname_subS</code> : Substring of Last name of first 4 characters

<code>role</code> : Role of actual user (eg. teaching_assistant, instructor)

<code>num</code> : A random number generated between 1 to 9

==Running the anonymization script==
This script anonymizes the records present in the <code>expertiza_development</code> database

To run this script, you have to switch to sudo user with the command <code>sudo su</code>
<pre>
cd lib/tasks
</pre>

<pre>
rake db:data:scrub --trace
</pre>

After the task is completed, login to mysql
<pre>
mysql -u root -p
use expertiza_development;
select name, fullname, email from users limit 10;
</pre>

To check for any duplicate entries, run this SQL command

<pre>
select name, count(name) from users group by name having count(name) >1;
</pre>

'''*Note down the names, and add them to the blacklist, since we would not be able to login to these accounts
'''

'''*Ensure there are no more than 8 duplicate entries of students and none of other roles. Otherwise re-run the script
'''

Documentation for Database Anonymization

2023-03-13T07:52:48Z

Rsshives:

We use Database Anonymization to scrub the database and replace real-time Expertiza records with fake data to use it for development purposes and to avoid hamper the integrity while development!

==Initial Setup for Anonymization==
We use the <code>faker</code> gem to create fake names and replace the actual data with the names generated by this gem.

In the <code>Gemfile</code> add
<pre>
gem 'faker', '1.9.3', group: [:test, :development], require: false
</pre>

In config/locales, change <code>en-US.yml</code> to <code>en.yml</code>

Inside the file, replace <code>en-US:</code> to <code>en:</code>
(This is to avoid any translation error thrown by i18n)

Have a database <code>expertiza_development</code> with real-time records of the expertiza database

==Anonymization Script==

===Rake task to run the script===
In <code>lib/tasks/scrub_database.rake</code> we have defined a namespace <code>db</code> inside which we have a task <code>scrub</code>

<pre>
namespace :db do
namespace :data do
desc 'Scrubs the database of user information'
task scrub: :environment do
require './db/data_migrations/scrub_database.rb' # Require the data migration class
ScrubDatabase.run! # Run the function which contains the logic
end
end
end
</pre>

===Logic of the script===
In <code>db/data_migrations/scrub_database.rb</code> we have the main logic to anonymize the script

<pre>
require 'i18n'
require 'faker'

class ScrubDatabase
I18n.default_locale = :en # here, we set the default locale to be used
I18n.reload!
def self.run! # this is the function called in the rake file
User.find_each do |user|
#logic for anonymizing the records
end
end
end
</pre>

===Format for anonymizing===

For Students:
<pre>
user.name = "<fname>_<lname_subS><num>"
user.fullname = "<lname>, <fname>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

For Others:
<pre>
user.name = "<role>_<fname>_<lname_subS><num>"
user.fullname = "<fname>, <role>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

where

<code>fname</code> : First name generated by Faker gem

<code>lname</code> : Last name generated by Faker gem

<code>lname_subS</code> : Substring of Last name of first 4 characters

<code>role</code> : Role of actual user (eg. teaching_assistant, instructor)

<code>num</code> : A random number generated between 1 to 9

==Running the anonymization script==
This script anonymizes the records present in the <code>expertiza_development</code> database

To run this script, you have to switch to sudo user with the command <code>sudo su</code>
<pre>
cd lib/tasks
</pre>

<pre>
rake db:data:scrub --trace
</pre>

After the task is completed, login to mysql
<pre>
mysql -u root -p
use expertiza_development;
select name, fullname, email from users limit 10;
</pre>

To check for any duplicate entries, run this SQL command

<pre>
select name, count(name) from users group by name having count(name) >1;
</pre>

'''*Note down the names, and add them to the blacklist, since we would not be able to login to these accounts
'''

'''*Ensure there are no more than 8 duplicate entries of students and none of other roles. Otherwise re-run the script
'''

Documentation for Database Anonymization

2023-03-13T07:51:56Z

Rsshives:

Documentation for Database Anonymization

2023-03-13T07:50:28Z

Rsshives:

We use Database Anonymization to scrub the database and replace real-time Expertiza records with fake data to use it for development purposes and to avoid hamper the integrity while development!

==Initial Setup for Anonymization==
We use the <code>faker</code> gem to create fake names and replace the actual data with the names generated by this gem.

In the <code>Gemfile</code> add
<pre>
gem 'faker', '1.9.3', group: [:test, :development], require: false
</pre>

In config/locales, change <code>en-US.yml</code> to <code>en.yml</code>

Inside the file, replace <code>en-US:</code> to <code>en:</code>
(This is to avoid any translation error thrown by i18n)

Have a database <code>expertiza_development</code> with real-time records of the expertiza database

==Anonymization Script==

===Rake task to run the script===
In <code>lib/tasks/scrub_database.rake</code> we have defined a namespace <code>db</code> inside which we have a task <code>scrub</code>

<pre>
namespace :db do
namespace :data do
desc 'Scrubs the database of user information'
task scrub: :environment do
require './db/data_migrations/scrub_database.rb' # Require the data migration class
ScrubDatabase.run! # Run the function which contains the logic
end
end
end
</pre>

===Logic of the script===
In <code>db/data_migrations/scrub_database.rb</code> we have the main logic to anonymize the script

<pre>
require 'i18n'
require 'faker'

class ScrubDatabase
I18n.default_locale = :en # here, we set the default locale to be used
I18n.reload!
def self.run! # this is the function called in the rake file
User.find_each do |user|
#logic for anonymizing the records
end
end
end
</pre>

===Format for anonymizing===

For Students:
<pre>
user.name = "<fname>_<lname_subS><num>"
user.fullname = "<lname>, <fname>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

For Others:
<pre>
user.name = "<role>_<fname>_<lname_subS><num>"
user.fullname = "<fname>, <role>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

where

<code>fname</code> : First name generated by Faker gem

<code>lname</code> : Last name generated by Faker gem

<code>lname_subS</code> : Substring of Last name of first 4 characters

<code>role</code> : Role of actual user (eg. teaching_assistant, instructor)

<code>num</code> : A random number generated between 1 to 9

==Running the anonymization script==
This script anonymizes the records present in the <code>expertiza_development</code> database

To run this script, you have to switch to sudo user with the command <code>sudo su</code>
<pre>
cd lib/tasks
</pre>

<pre>
rake db:data:scrub --trace
</pre>

After the task is completed, login to mysql
<pre>
mysql -u root -p
use expertiza_development;
select name, email from users limit 10;
</pre>

To check for any duplicate entries, run this SQL command

<pre>
select name, count(name) from users group by name having count(name) >1;
</pre>

'''*Note down the names, and add them to the blacklist, since we would not be able to login to these accounts
'''

'''*Ensure there are no more than 8 duplicate entries of students and none of other roles.
'''

Documentation for Database Anonymization

2023-03-13T07:50:13Z

Rsshives:

We use Database Anonymization to scrub the database and replace real-time Expertiza records with fake data to use it for development purposes and to avoid hamper the integrity while development!

==Initial Setup for Anonymization==
We use the <code>faker</code> gem to create fake names and replace the actual data with the names generated by this gem.

In the <code>Gemfile</code> add
<pre>
gem 'faker', '1.9.3', group: [:test, :development], require: false
</pre>

In config/locales, change <code>en-US.yml</code> to <code>en.yml</code>

Inside the file, replace <code>en-US:</code> to <code>en:</code>
(This is to avoid any translation error thrown by i18n)

Have a database <code>expertiza_development</code> with real-time records of the expertiza database

==Anonymization Script==

===Rake task to run the script===
In <code>lib/tasks/scrub_database.rake</code> we have defined a namespace <code>db</code> inside which we have a task <code>scrub</code>

<pre>
namespace :db do
namespace :data do
desc 'Scrubs the database of user information'
task scrub: :environment do
require './db/data_migrations/scrub_database.rb' # Require the data migration class
ScrubDatabase.run! # Run the function which contains the logic
end
end
end
</pre>

===Logic of the script===
In <code>db/data_migrations/scrub_database.rb</code> we have the main logic to anonymize the script

<pre>
require 'i18n'
require 'faker'

class ScrubDatabase
I18n.default_locale = :en # here, we set the default locale to be used
I18n.reload!
def self.run! # this is the function called in the rake file
User.find_each do |user|
#logic for anonymizing the records
end
end
end
</pre>

===Format for anonymizing===

For Students:
<pre>
user.name = "<fname>_<lname_subS><num>"
user.fullname = "<lname>, <fname>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

For Others:
<pre>
user.name = "<role>_<fname>_<lname_subS><num>"
user.fullname = "<fname>, <role>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

where

<code>fname</code> : First name generated by Faker gem

<code>lname</code> : Last name generated by Faker gem

<code>lname_subS</code> : Substring of Last name of first 4 characters

<code>role</code> : Role of actual user (eg. teaching_assistant, instructor)

<code>num</code> : A random number generated between 1 to 9

==Running the anonymization script==
This script anonymizes the records present in the <code>expertiza_development</code> database

To run this script, you have to switch to sudo user with the command <code>sudo su</code>
<pre>
cd lib/tasks
</pre>

<pre>
rake db:data:scrub --trace
</pre>

After the task is completed, login to mysql
<pre>
mysql -u root -p
use expertiza_development;
select name, email from users limit 10;
</pre>

To check for any duplicate entries, run this SQL command

<pre>
select name, count(name) from users group by name having count(name) >1;
</pre>

'''*Note down the names, and add them to the blacklist, since we would not be able to login to these accounts
'''
'''*Ensure there are no more than 8 duplicate entries of students and none of other roles.
'''

Documentation for Database Anonymization

2023-03-13T07:48:37Z

Rsshives:

We use Database Anonymization to scrub the database and replace real-time Expertiza records with fake data to use it for development purposes and to avoid hamper the integrity while development!

==Initial Setup for Anonymization==
We use the <code>faker</code> gem to create fake names and replace the actual data with the names generated by this gem.

In the <code>Gemfile</code> add
<pre>
gem 'faker', '1.9.3', group: [:test, :development], require: false
</pre>

In config/locales, change <code>en-US.yml</code> to <code>en.yml</code>

Inside the file, replace <code>en-US:</code> to <code>en:</code>
(This is to avoid any translation error thrown by i18n)

Have a database <code>expertiza_development</code> with real-time records of the expertiza database

==Anonymization Script==

===Rake task to run the script===
In <code>lib/tasks/scrub_database.rake</code> we have defined a namespace <code>db</code> inside which we have a task <code>scrub</code>

<pre>
namespace :db do
namespace :data do
desc 'Scrubs the database of user information'
task scrub: :environment do
require './db/data_migrations/scrub_database.rb' # Require the data migration class
ScrubDatabase.run! # Run the function which contains the logic
end
end
end
</pre>

===Logic of the script===
In <code>db/data_migrations/scrub_database.rb</code> we have the main logic to anonymize the script

<pre>
require 'i18n'
require 'faker'

class ScrubDatabase
I18n.default_locale = :en # here, we set the default locale to be used
I18n.reload!
def self.run! # this is the function called in the rake file
User.find_each do |user|
#logic for anonymizing the records
end
end
end
</pre>

===Format for anonymizing===

For Students:
<pre>
user.name = "<fname>_<lname_subS><num>"
user.fullname = "<lname>, <fname>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

For Others:
<pre>
user.name = "<role>_<fname>_<lname_subS><num>"
user.fullname = "<fname>, <role>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

where

<code>fname</code> : First name generated by Faker gem

<code>lname</code> : Last name generated by Faker gem

<code>lname_subS</code> : Substring of Last name of first 4 characters

<code>role</code> : Role of actual user (eg. teaching_assistant, instructor)

<code>num</code> : A random number generated between 1 to 9

==Running the anonymization script==
This script anonymizes the records present in the <code>expertiza_development</code> database

To run this script, you have to switch to sudo user with the command <code>sudo su</code>
<pre>
cd lib/tasks
</pre>

<pre>
rake db:data:scrub --trace
</pre>

After the task is completed, login to mysql
<pre>
mysql -u root -p
use expertiza_development;
select name, email from users limit 10;
</pre>

To check for any duplicate entries, run this SQL command

<pre>
select name, count(name) from users group by name having count(name) >1;
</pre>

'''Note down the names, and add them to the blacklist, since we would not be able to login to these accounts
Ensure there are no more than 8 duplicate entries of students and none of other roles.'''

Documentation for Database Anonymization

2023-03-13T07:46:32Z

Rsshives:

We use Database Anonymization to scrub the database and replace real-time Expertiza records with fake data to use it for development purposes and to avoid hamper the integrity while development!

==Initial Setup for Anonymization==
We use the <code>faker</code> gem to create fake names and replace the actual data with the names generated by this gem.

In the <code>Gemfile</code> add
<pre>
gem 'faker', '1.9.3', group: [:test, :development], require: false
</pre>

In config/locales, change <code>en-US.yml</code> to <code>en.yml</code>

Inside the file, replace <code>en-US:</code> to <code>en:</code>
(This is to avoid any translation error thrown by i18n)

Have a database <code>expertiza_development</code> with real-time records of the expertiza database

==Anonymization Script==

===Rake task to run the script===
In <code>lib/tasks/scrub_database.rake</code> we have defined a namespace <code>db</code> inside which we have a task <code>scrub</code>

<pre>
namespace :db do
namespace :data do
desc 'Scrubs the database of user information'
task scrub: :environment do
require './db/data_migrations/scrub_database.rb' # Require the data migration class
ScrubDatabase.run! # Run the function which contains the logic
end
end
end
</pre>

===Logic of the script===
In <code>db/data_migrations/scrub_database.rb</code> we have the main logic to anonymize the script

<pre>
require 'i18n'
require 'faker'

class ScrubDatabase
I18n.default_locale = :en # here, we set the default locale to be used
I18n.reload!
def self.run! # this is the function called in the rake file
User.find_each do |user|
#logic for anonymizing the records
end
end
end
</pre>

===Format for anonymizing===

For Students:
<pre>
user.name = "<fname>_<lname_subS><num>"
user.fullname = "<lname>, <fname>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

For Others:
<pre>
user.name = "<role>_<fname>_<lname_subS><num>"
user.fullname = "<fname>, <role>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

where

<code>fname</code> : First name generated by Faker gem

<code>lname</code> : Last name generated by Faker gem

<code>lname_subS</code> : Substring of Last name of first 4 characters

<code>role</code> : Role of actual user (eg. teaching_assistant, instructor)

<code>num</code> : A random number generated between 1 to 9

==Running the anonymization script==
This script anonymizes the records present in the <code>expertiza_development</code> database

To run this script, you have to switch to sudo user with the command <code>sudo su</code>

cd lib/tasks

rake db:data:scrub --trace

After the task is completed, login to mysql

mysql -u root -p

use expertiza_development;

select name, email from users limit 10;

To check for any duplicate entries, run this SQL command

select name, count(name) from users group by name having count(name) >1;

'''Note down the names, and add them to the blacklist, since we would not be able to login to these accounts
Ensure there are no more than 8 duplicate entries of students and none of other roles.'''

Documentation for Database Anonymization

2023-03-13T07:46:03Z

Rsshives:

We use Database Anonymization to scrub the database and replace real-time Expertiza records with fake data to use it for development purposes and to avoid hamper the integrity while development!

==Initial Setup for Anonymization==
We use the <code>faker</code> gem to create fake names and replace the actual data with the names generated by this gem.
In the <code>Gemfile</code> add
<pre>
gem 'faker', '1.9.3', group: [:test, :development], require: false
</pre>

In config/locales, change <code>en-US.yml</code> to <code>en.yml</code>

Inside the file, replace <code>en-US:</code> to <code>en:</code>
(This is to avoid any translation error thrown by i18n)

Have a database <code>expertiza_development</code> with real-time records of the expertiza database

==Anonymization Script==

===Rake task to run the script===
In <code>lib/tasks/scrub_database.rake</code> we have defined a namespace <code>db</code> inside which we have a task <code>scrub</code>

<pre>
namespace :db do
namespace :data do
desc 'Scrubs the database of user information'
task scrub: :environment do
require './db/data_migrations/scrub_database.rb' # Require the data migration class
ScrubDatabase.run! # Run the function which contains the logic
end
end
end
</pre>

===Logic of the script===
In <code>db/data_migrations/scrub_database.rb</code> we have the main logic to anonymize the script

<pre>
require 'i18n'
require 'faker'

class ScrubDatabase
I18n.default_locale = :en # here, we set the default locale to be used
I18n.reload!
def self.run! # this is the function called in the rake file
User.find_each do |user|
#logic for anonymizing the records
end
end
end
</pre>

===Format for anonymizing===

For Students:
<pre>
user.name = "<fname>_<lname_subS><num>"
user.fullname = "<lname>, <fname>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

For Others:
<pre>
user.name = "<role>_<fname>_<lname_subS><num>"
user.fullname = "<fname>, <role>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

where

<code>fname</code> : First name generated by Faker gem

<code>lname</code> : Last name generated by Faker gem

<code>lname_subS</code> : Substring of Last name of first 4 characters

<code>role</code> : Role of actual user (eg. teaching_assistant, instructor)

<code>num</code> : A random number generated between 1 to 9

==Running the anonymization script==
This script anonymizes the records present in the <code>expertiza_development</code> database

To run this script, you have to switch to sudo user with the command <code>sudo su</code>

cd lib/tasks

rake db:data:scrub --trace

After the task is completed, login to mysql

mysql -u root -p

use expertiza_development;

select name, email from users limit 10;

To check for any duplicate entries, run this SQL command

select name, count(name) from users group by name having count(name) >1;

'''Note down the names, and add them to the blacklist, since we would not be able to login to these accounts
Ensure there are no more than 8 duplicate entries of students and none of other roles.'''

Documentation for Database Anonymization

2023-03-13T07:40:49Z

Rsshives:

We use Database Anonymization to scrub the database and replace real-time Expertiza records with fake data to use it for development purposes and to avoid hamper the integrity while development!

==Initial Setup for Anonymization==
We use the <code>faker</code> gem to create fake names and replace the actual data with the names generated by this gem.
In the Gemfile add
<pre>
gem 'faker', '1.9.3', group: [:test, :development], require: false
</pre>

In config/locales, change en-US.yml to en.yml
Inside the file, replace en-US: to en:
(This is to avoid any translation error thrown by i18n)

Have a database expertiza_development with real-time records of the expertiza database

==Anonymization Script==

===Rake task to run the script===
In lib/tasks/scrub_database.rake we have defined a namespace db inside which we have a task scrub

<pre>
namespace :db do
namespace :data do
desc 'Scrubs the database of user information'
task scrub: :environment do
require './db/data_migrations/scrub_database.rb' # Require the data migration class
ScrubDatabase.run! # Run the function which contains the logic
end
end
end
</pre>

===Logic of the script===
In db/data_migrations/scrub_database.rb we have the main logic to anonymize the script

<pre>
require 'i18n'
require 'faker'

class ScrubDatabase
I18n.default_locale = :en # here, we set the default locale to be used
I18n.reload!
def self.run! # this is the function called in the rake file
User.find_each do |user|
#logic for anonymizing the records
end
end
end
</pre>

Format for anonymizing is as follows

For Students:
<pre>
user.name = "<fname>_<lname_subS><num>"
user.fullname = "<lname>, <fname>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

For Others:
<pre>
user.name = "<role>_<fname>_<lname_subS><num>"
user.fullname = "<fname>, <role>
user.email = "expertiza@mailinator.com"
user.password = "password"
</pre>

where

<code>fname</code> : First name generated by Faker gem
<code>lname</code> : Last name generated by Faker gem
<code>lname_subS</code> : Substring of Last name of first 4 characters
<code>role</code> : Role of actual user (eg. teaching_assistant, instructor)
<code>num</code> : A random number generated between 1 to 9

==Running the anonymization script==
This script anonymizes the records present in the expertiza_development database

To run this script, you have to switch to sudo user with the command sudo su

cd lib/tasks

rake db:data:scrub --trace

After the task is completed, login to mysql

mysql -u root -p

use expertiza_development;

select name, email from users limit 10;

To check for any duplicate entries, run this SQL command

select name, count(name) from users group by name having count(name) >1;

'''Note down the names, and add them to the blacklist, since we would not be able to login to these accounts
Ensure there are no more than 8 duplicate entries of students and none of other roles.'''

Documentation for Database Anonymization

2023-03-13T07:05:21Z

Rsshives:

Documentation for Database Anonymization

2023-03-13T07:01:41Z

Rsshives:

We use Database Anonymization to scrub the database and replace real-time Expertiza records with fake data to use it for development purposes and to avoid hamper the integrity while development!

Documentation for Database Anonymization

2023-03-13T06:58:44Z

Rsshives: Created page with "Hello"

Hello

Expertiza documentation

2023-03-13T06:58:27Z

Rsshives: /* Database Guides */

[[Image:715px-EXPERTIZA.png|715px]]

= Welcome to the Expertiza project! =

The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

== Short Powerpoint introductions ==
*My [http://research.csc.ncsu.edu/efg/expertiza/presentations/ELI_11_wiki_textbook.ppt presentation] on using Expertiza to support wiki-textbook creation, at the 2011 EDUCAUSE Learning Initiative conference, February 15, 2011
*My [http://research.csc.ncsu.edu/efg/expertiza/presentations/Purdue_TLT_2009.ppt plenary talk] at the Purdue TLT Conference on April 22, 2009
*We invite you to view the original [http://research.csc.ncsu.edu/efg/expertiza/presentations/Expertiza-short.htm rationale] for the system.
*You can walk through a [http://research.csc.ncsu.edu/efg/expertiza/presentations/Expertiza%20in%20Action.ppt virtual demo] of the system.

== Papers ==
*A [http://innovateonline.info/index.php?view=article&id=365 prose rendition] of the rationale was published in [http://innovateonline.info/ Innovate] in 2007. (To view it, you need to register, and you will receive e-mail each time a new issue of this very interesting and useful journal is published.)
*Other papers on Expertiza can be found [http://research.csc.ncsu.edu/efg/expertiza/papers/ here].

== Video presentations ==

*An [http://connectpro86502729.na6.acrobat.com/p99048610/ overview] of Expertiza ("Software support for teamwork and authentic assessment [http://research.csc.ncsu.edu/efg/expertiza/presentations/TLT_Live.ppt (slides)]") from the TLT Group's Friday Live, September 24, 2010
*[https://sas.elluminate.com/site/external/recording/playback/link/dropin.jnlp?sid=2008350&suid=D.2D2E269EE524FD263F89DA6872A41E Student-authored wiki textbooks: Composition and review] from the 2011 Global Education Consortium, November 18, 2011
*This [http://educause.mediasite.com/mediasite/SilverlightPlayer/Default.aspx?peid=cdeebca6d1a34610923bcabd4c2d2fd91d session from EDUCAUSE ELI 2011] describes how Expertiza can be used to review wiki-textbook contributions. It is an earlier version of the presentation above that includes a live demo.
*This Innovate [http://breeze.uliveandlearn.com/p10263667/ Webcast] from July 2007 includes the rationale and a demo of the system.
*A six-minute [http://www.youtube.com/watch?v=hVpS7qvC5Zs interview] from the 2009 Lilly Conference on College Teaching describes the goals and realization of the project. (Note: Background noise may be distracting.)
*This Innovate [http://breeze.uliveandlearn.com/p84785847/ Ideagora] discussion from January 2009 describes the social-networking features planned for Expertiza.
*[https://sas.elluminate.com/site/external/jwsdetect/playback.jnlp?psid=2009-03-17.1032.M.F13AAE88367AEE982449E713075D42.vcr Forming and managing student teams and peer feedback in Expertiza], a presentation at the UNC TLT conference in March 2009.

== Documentation ==

*An [http://research.csc.ncsu.edu/efg/expertiza/reports/Instructor_documentation.doc instructor manual], explaining how to create an deploy an assignment in Expertiza.
*An [http://research.csc.ncsu.edu/efg/expertiza/presentations/videos/instructor.swf instructor video], slightly dated, showing how to create and deploy an assignment
*A [http://rajanalwan.com/ui_guidelines/ design document] for the application.
* A guide for [[Creating_Custom_Rubric]]
*For students, a [http://research.csc.ncsu.edu/efg/expertiza/presentations/student_documentation.ppt Powerpoint] or [http://research.csc.ncsu.edu/efg/expertiza/presentations/student_documentation.pdf PDF] presentation explaining how to submit and review an assignment with Expertiza.
*For students, a [http://research.csc.ncsu.edu/efg/expertiza/presentations/videos/student.swf video] showing how to use the system to submit and review an assignment.
*For students, a [http://research.csc.ncsu.edu/efg/expertiza/presentations/student_wiki_documentation.ppt Powerpoint] or [http://research.csc.ncsu.edu/efg/expertiza/presentations/student_wiki_documentation.pdf PDF] presentation explaining how to submit and review wiki pages with Expertiza.
*For students, a [http://courses.ncsu.edu/csc517/common/homework/topic-signup-team-formation.ppt Powerpoint] or [http://courses.ncsu.edu/csc517/common/homework/topic-signup-team-formation.pdf PDF] presentation explaining how to form teams and sign up for topics.

== Developers section ==
''Expertiza now has a Java dependency, so the machine you are using to develop Expertiza on should have the JVM installed.''
=== Development Environment Setup Guides ===
* [[Creating a Linux Development Environment for Expertiza - Installation Guide]]
**[http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:Linux:Debian Development setup for Ubuntu/Debian]
* [[Development:Setup:OSX]]
*[http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:Linux:RHEL Development setup for Linux RHEL ]
*[[Developing Expertiza on the VCL]]
*Developing Expertiza on Virtual Box
** [https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing Download the VirtualBox Ubuntu image here]
** [https://drive.google.com/open?id=1YlqiSsbZl8TfPuQmIFG7TYo2npWzqqu4 or try the Lubuntu image here if the Ubuntu image is too heavy for your PC/Laptop ]
*Docker image (Only if you are familiar with docker. You will need it if you choose Expertiza to do OSS project.)
** Please follow the instruction in https://hub.docker.com/r/winbobob/expertiza-fall2016/

=== Database Guides ===
*[[Deploying and importing production data with capistrano]]
*[[Documentation on Database Tables]]
*[[Documentation for Database Anonymization]]

=== Security Guidelines ===
*[[Security guidelines for Expertiza]]
=== Git ===
*[[Version Control with the Git repository]]
*[http://wiki.expertiza.ncsu.edu/index.php/How_to_Begin_a_Project_from_the_Current_Expertiza_Repository How to Begin a Project from the Current Expertiza Repository]

=== Ruby and Rails ===
*[[Restart Instructions for Expertiza]]
*[[Deploying Expertiza to Production]]
*[[Gem dependencies]]
*[[http://wiki.expertiza.ncsu.edu/index.php?title=Using_Cucumber_with_Expertiza Using Cucumber with Expertiza]]

=== Misc ===
*[[Setting up and using TA functionality]]
*[[Restart instructions for Wiki]]
*[[Scoring & Grading Methods (Fall '21)]]

=== Final Projects on Expertiza for Fall 2015 ===
[https://docs.google.com/document/d/1t0keeNQ2kP0NmcgIrtQXGi5K_GhQYcKzEVWJPPRBOHE/edit?pli=1 The Expertiza Final Project Submission] 

== Links ==
[http://expertiza.ncsu.edu The Expertiza application] 
[http://research.csc.ncsu.edu/efg/expertiza/papers Papers on Expertiza] 
[http://research.csc.ncsu.edu/efg/expertiza/presentations/Expertiza-short.htm PowerPoint Presentation - The Expertiza platform] 
[http://www.csc.ncsu.edu/news/463 Expertiza Platform Takes Honorable Mention in Gertrude Cox Awards]

== Acknowledgments ==

This material is based upon work supported by the National Science Foundation under Grant No. 0536558. Additional funding from the NCSU Learning in a Technology-Rich Environment (LITRE) program, the NCSU Faculty Center for Teaching and Learning, the NCSU STEM Initiative, and the Center for Advanced Computing and Communication.

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:59:51Z

Rsshives:

==E2262. Further refactoring and improvement of review_mapping_helper==

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza is an all inclusive web service that allows instructors to create, edit and manage assignments. This includes the functionality for topic selection and team formation across various projects and assignments. Expertiza allows for a variety of submission types including URL and PDF. Expertiza also allows the instructor to assign peer reviews and team assessments.

==Team==
===Mentor===
Jialin Cui (jcui9 ncsu.edu)

===Team Members===
Gun Ju Im (gim@ncsu.edu) 
Rithik Jain (rjain25@ncsu.edu) 
Rohan Shiveshwarkar (rsshives@ncsu.edu) 

==Description of Project==

This wiki describes the work done in refactoring the <code>app/helpers/review_mapping_helper.rb</code> and associated files calling the methods contained in it. The main goal of the tasks was to make the code clearer and more understandable to the reader while retaining the functionality. The goal included inserting comments wherever necessary.

==File Description==

The <code>review_mapping_helper.rb</code> has methods that help return charts and other graphical data to the frontend

==What is Needed==

This project builds on E2225, and should begin with the refactoring done by that project. That project focused on simplifying the methods in <code>review_mapping_helper.rb</code>, while this project looks at making the code more understandable and transparent.

==Files Modified==

* app/helpers/review_mapping_helper.rb 
* app/views/reports/_calibration_report.html.erb
* app/views/reports/_feedback_report.html.erb
* app/views/reports/_review_report.html.erb
* app/views/reports/_team_score.html.erb
* app/views/reports/_team_score_score_awarded.html.erb
* spec/features/review_mapping_helper_spec.rb
* spec/helpers/review_mapping_helper_spec.rb

==Issues to be Addressed==

* method get_data_for_review_report marshals a lot of data together and passes back a data structure. It is used in views/reports/_review_report.html.erb, but it is quite difficult to see how the data is displayed. It violates the Expert pattern because the view needs to know how to break apart the structure that is passed to it. Doing the same thing with partials in views/reports would make the code easier to follow 
* The next three methods involve team “color”. Color coding is explained on this page and this page for the E1789 project and this page for E1815. The code for these methods is not at all clear and should be refactored. And please use the American spelling “color”. 
* Various method names begin with get. This is not Ruby-like. Change the names to something more appropriate. 
* get_awarded_review_score computes an overall score based on scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in response_map.rb. Contact Nicholas Himes (nnhimes@ncsu.edu) for particulars. Change this method to use the new code. 
* The method sort_reviewer_by_review_volume_desc should be generalized so that it can sort by any metric, not just review volume. Other metrics might include number of suggestions or number of suggestions + number of problems detected. This method should not be counting the number of review rounds! Since other places in the code will need to know the number of review rounds, it should be calculated somewhere else in the system. 
* The next several methods generate charts. They are cohesive enough that they should be in their own separate file, either another helper or a mixin. 
* Then there is a method list_review_submissions. It’s not at all clear that this method is needed, though it is used in one view. Look on the Expertiza wiki and see if there is a better way. 
* There are several methods for feedback_response_maps. It is not at all clear why they are here. Look on the Expertiza wiki for the documentation, and see if you can replace them by calls to other methods, or at least make it clearer what they are doing. 
* The file ends with three small classes being defined. There are no comments at all to explain what is being done. Look them up on the Expertiza wiki and refactor or comment them, whichever seems more appropriate. 

==Problems Tackled==

* '''Issue #1:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 

* '''Issue #2:''' The code was not clear to the reader 
'''Methods involved:''' <code>team_color()</code>, <code>obtain_team_color()</code>, <code>check_submission_state()</code> 
'''Initial Code:''' The method <code>obtain_team_color</code> was calling the method <code>check_submission_state()</code> and passing 'color' array. The method <code>check_submission_state()</code> was checking multiple parameters and was pushing certain colors into the array. The method <code>obtain_team_color()</code> was then returning the last element of the array to the method <code>team_color()</code> 
'''Problem:''' The color array being passed around was unclear and was an unrequired data structure. 
Code was as follows
<pre>
def team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at
# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)
# Returning color based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
obtain_team_color(response_map, assignment_created, assignment_due_dates)
end
else
'red'
end
end

# loops through the number of assignment review rounds and obtains the team color
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end

# checks the submission state within each round and assigns team color
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color.push 'green'
else
link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>
'''Solution:''' The color was changed to a variable, and on each check in the method check_submission_state(), the color variable is updated. 
Updated Code is as follows:
<pre>def team_color(response_map)
color = 'red'
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at
# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)
# Returning color based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).nil?
color = 'brown'
elsif response_for_each_round?(response_map)
color = 'blue'
else
color = obtain_team_color(response_map, assignment_created, assignment_due_dates)
end
color #returning the value of color
end
end

# loops through the number of assignment review rounds and obtains the team color
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = 'red' # assigning the color default to red
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color
end

# checks the submission state within each round and assigns team color
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color = 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color = 'green'
else
link_updated_at = get_link_updated_at(link)
color = link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>
'''Contributor:''' Rohan Shiveshwarkar
 
* '''Issue #3:''' Various method names are not Ruby-like. 
'''Methods involved:''' get_data_for_review_report(), get_team_color(), get_link_updated_at(), get_team_reviewed_link_name(), get_awarded_review_score(), get_each_review_and_feedback_response_map(), get_certain_review_and_feedback_response_map(), get_css_style_for_calibration_report() 
'''Initial Code:''' Same as methods involved above 
'''Problem:''' According to Ruby Style Guide, we should avoid prefixing method names with get_. 
'''Solution:''' I got rid of get_ on every method name which begins with get_. I also searched same methods which were used in other files, and also changed their names. 
'''Contributor:''' Gunju Im
 
* '''Issue #4:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 
* '''Issue #5:''' Generalizing the method sort_reviewer_by_review_volume_desc() 
'''Methods involved:''' <code>sort_reviewer_by_review_volume_desc()</code> 
'''Initial Code:''' The method was only taking into account the metric: review volume 
'''Problem:''' The Response has several other metrics to be considered including number of suggestions, or number of suggestions + number of problems detected 
Code was as follows 
'''review_mapping_helper.rb'''
<pre>def sort_reviewer_by_review_volume_desc
@reviewers.each do |r|
# get the volume of review comments
review_volumes = Response.volume_of_review_comments(@assignment.id, r.id)
r.avg_vol_per_round = []
review_volumes.each_index do |i|
if i.zero?
r.overall_avg_vol = review_volumes[0]
else
r.avg_vol_per_round.push(review_volumes[i])
end
end
end
# get the number of review rounds for the assignment
@num_rounds = @assignment.num_review_rounds.to_f.to_i
@all_reviewers_avg_vol_per_round = []
@all_reviewers_overall_avg_vol = @reviewers.inject(0) { |sum, r| sum + r.overall_avg_vol } / (@reviewers.blank? ? 1 : @reviewers.length)
@num_rounds.times do |round|
@all_reviewers_avg_vol_per_round.push(@reviewers.inject(0) { |sum, r| sum + r.avg_vol_per_round[round] } / (@reviewers.blank? ? 1 : @reviewers.length))
end
@reviewers.sort! { |r1, r2| r2.overall_avg_vol <=> r1.overall_avg_vol }
end
</pre>

'''_review_report.html.erb'''
<pre>

(Line 61) <% sort_reviewer_by_review_volume_desc.each_with_index do |reviewer, index| %>
</pre>

'''Solution:''' Created a generalized method <code>sort_reviewer_by_review_metric_desc()</code> which takes in a string parameter specifying the metric to be considered (eg. "review_volume") and edited the function call in <code>_review_report.html.erb</code> file and in <code>spec/helpers/review_mapping_helper_spec.rb</code> file 
Code is as follows: 
'''review_mapping_helper.rb'''
<pre>
# Generalized function which takes in string parameter specifying the metric to be sorted
def sort_reviewer_by_review_metric_desc(metric) #metric is the string value of the metric to be sorted with
if (metric.eql?("review_volume"))
@reviewers.each do |r|
# get the volume of review comments
review_volumes = Response.volume_of_review_comments(@assignment.id, r.id)
r.avg_vol_per_round = []
review_volumes.each_index do |i|
if i.zero?
r.overall_avg_vol = review_volumes[0]
else
r.avg_vol_per_round.push(review_volumes[i])
end
end
end

# get the number of review rounds for the assignment
@num_rounds = @assignment.num_review_rounds.to_f.to_i
@all_reviewers_avg_vol_per_round = []
@all_reviewers_overall_avg_vol = @reviewers.inject(0) { |sum, r| sum + r.overall_avg_vol } / (@reviewers.blank? ? 1 : @reviewers.length)
@num_rounds.times do |round|
@all_reviewers_avg_vol_per_round.push(@reviewers.inject(0) { |sum, r| sum + r.avg_vol_per_round[round] } / (@reviewers.blank? ? 1 : @reviewers.length))
end
@reviewers.sort! { |r1, r2| r2.overall_avg_vol <=> r1.overall_avg_vol }
end
end
</pre>

'''_review_report.html.erb'''
<pre>

(Line 61) <% sort_reviewer_by_review_metric_desc("review_volume").each_with_index do |reviewer, index| %>

</pre>
'''Contributor:''' Rohan Shiveshwarkar
 
* '''Issue #6:''' Refactor charts generating methods into another file as a helper/mixin 
'''Methods involved:''' <code>initialize_chart_elements()</code>, <code>display_volume_metric_chart()</code>, <code>display_tagging_interval_chart()</code>, <code>calculate_key_chart_information()</code> 
'''Initial Code:''' The methods above were included in the <code>review_mapping_helper.rb</code> file 
'''Problem:''' They are cohesive enough that they should be in their own separate file, either another helper or a mixin 
'''Solution:''' Created a new file <code>chart_generator_helper.rb</code> and created a new module <code>ChartGeneratorHelper</code> and shifted all the functions into that helper, and included it into the module <code>ReviewMappingHelper</code> in the <code>review_mapping_helper.rb</code> file 
The new code is organized as below 

'''chart_generator_helper.rb'''
<pre>
module ChartGeneratorHelper
def initialize_chart_elements()
def display_volume_metric_chart()
def display_tagging_interval_chart()
def calculate_key_chart_information()</pre>
 
'''review_mapping_helper.rb'''

<pre>
module ReviewMappingHelper
include ChartGeneratorHelper
...
...
...
...</pre>

'''Contributor:''' Rohan Shiveshwarkar
 

* '''Issue #7:''' A method list_review_submissions is not clear that it is needed. 
'''Methods involved:''' list_review_submissions 
'''Initial Code:''' def list_review_submissions(participant_id, reviewee_team_id, response_map_id)
participant = Participant.find(participant_id)
team = AssignmentTeam.find(reviewee_team_id)
html = ''
unless team.nil? || participant.nil?
review_submissions_path = team.path + '_review' + '/' + response_map_id.to_s
files = team.submitted_files(review_submissions_path)
html += display_review_files_directory_tree(participant, files) if files.present?
end
html.html_safe
end 
'''Problem:''' I can’t find its usage even though it is used in a view file; app/views/reports/_review_report.html.erb. 
'''Solution:''' I deleted the method in files; review_mapping_helper.rb and _review_report.html.erb. 

'''Contributor:''' Gunju Im
 
* '''Issue #8:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 
* '''Issue #9:''' Three classes which locate in the last part of file have no comments to explain what is being done. 
'''Methods involved:''' initialize(), reviews_per_team, reviews_needed, reviews_per_student 
'''Initial Code:''' class ReviewStrategy
attr_accessor :participants, :teams

def initialize(participants, teams, review_num)
@participants = participants
@teams = teams
@review_num = review_num
end
end

class StudentReviewStrategy < ReviewStrategy
def reviews_per_team
(@participants.size * @review_num * 1.0 / @teams.size).round
end

def reviews_needed
@participants.size * @review_num
end

def reviews_per_student
@review_num
end
end

class TeamReviewStrategy < ReviewStrategy
def reviews_per_team
@review_num
end

def reviews_needed
@teams.size * @review_num
end

def reviews_per_student
(@teams.size * @review_num * 1.0 / @participants.size).round
end
end 
'''Problem:''' Three classes are unclear. 
'''Solution:''' They are only used in this file. Also, they have methods that have same names with the other classes even if they are included in other class. At first, I tried to know what these classes meant and whether there was good way to refactor their method names. However, in conclusion, they are useless in the file, so I deleted them. 
'''Contributor:''' Gunju Im

==Peer Review Information==
For viewing the deployed project (on VCL) please click on this link -> http://152.7.177.222:8080/ 
And use the following credentials: Username = instructor6 | Password = password

==Test Cases==
===Rspec===
This is a refactoring project, so it is expected that the original functionality should be retained. All the test cases passed which implies that the refactored code did not break the existing functionality.
 
Proof of test cases being passed: 
[[File:Testpassedproof.png]]

==Github Links==
===Link to Expertiza Repository===
https://github.com/expertiza/expertiza 
===Link to Forked Repository===
https://github.com/RoninS28/expertiza-E2262 
===Link to Pull Request===
http://github.com/expertiza/expertiza/pull/2462

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:58:20Z

Rsshives:

==E2262. Further refactoring and improvement of review_mapping_helper==

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza is an all inclusive web service that allows instructors to create, edit and manage assignments. This includes the functionality for topic selection and team formation across various projects and assignments. Expertiza allows for a variety of submission types including URL and PDF. Expertiza also allows the instructor to assign peer reviews and team assessments.

==Team==
===Mentor===
Jialin Cui (jcui9 ncsu.edu)

===Team Members===
Gun Ju Im (gim@ncsu.edu) 
Rithik Jain (rjain25@ncsu.edu) 
Rohan Shiveshwarkar (rsshives@ncsu.edu) 

==Description of Project==

This wiki describes the work done in refactoring the review_mapping_helper.rb and associated files calling the methods contained in it. The main goal of the tasks was to make the code clearer and more understandable to the reader while retaining the functionality. The goal included inserting comments wherever necessary.

==File Description==

The review_mapping_helper has methods that help return charts and other graphical data to the frontend

==What is Needed==

This project builds on E2225, and should begin with the refactoring done by that project. That project focused on simplifying the methods in review_mapping_helper, while this project looks at making the code more understandable and transparent.

==Files Modified==

* app/helpers/review_mapping_helper.rb 
* app/views/reports/_calibration_report.html.erb
* app/views/reports/_feedback_report.html.erb
* app/views/reports/_review_report.html.erb
* app/views/reports/_team_score.html.erb
* app/views/reports/_team_score_score_awarded.html.erb
* spec/features/review_mapping_helper_spec.rb
* spec/helpers/review_mapping_helper_spec.rb

==Issues to be Addressed==

* method get_data_for_review_report marshals a lot of data together and passes back a data structure. It is used in views/reports/_review_report.html.erb, but it is quite difficult to see how the data is displayed. It violates the Expert pattern because the view needs to know how to break apart the structure that is passed to it. Doing the same thing with partials in views/reports would make the code easier to follow 
* The next three methods involve team “color”. Color coding is explained on this page and this page for the E1789 project and this page for E1815. The code for these methods is not at all clear and should be refactored. And please use the American spelling “color”. 
* Various method names begin with get. This is not Ruby-like. Change the names to something more appropriate. 
* get_awarded_review_score computes an overall score based on scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in response_map.rb. Contact Nicholas Himes (nnhimes@ncsu.edu) for particulars. Change this method to use the new code. 
* The method sort_reviewer_by_review_volume_desc should be generalized so that it can sort by any metric, not just review volume. Other metrics might include number of suggestions or number of suggestions + number of problems detected. This method should not be counting the number of review rounds! Since other places in the code will need to know the number of review rounds, it should be calculated somewhere else in the system. 
* The next several methods generate charts. They are cohesive enough that they should be in their own separate file, either another helper or a mixin. 
* Then there is a method list_review_submissions. It’s not at all clear that this method is needed, though it is used in one view. Look on the Expertiza wiki and see if there is a better way. 
* There are several methods for feedback_response_maps. It is not at all clear why they are here. Look on the Expertiza wiki for the documentation, and see if you can replace them by calls to other methods, or at least make it clearer what they are doing. 
* The file ends with three small classes being defined. There are no comments at all to explain what is being done. Look them up on the Expertiza wiki and refactor or comment them, whichever seems more appropriate. 

==Problems Tackled==

* '''Issue #1:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 

* '''Issue #2:''' The code was not clear to the reader 
'''Methods involved:''' <code>team_color()</code>, <code>obtain_team_color()</code>, <code>check_submission_state()</code> 
'''Initial Code:''' The method <code>obtain_team_color</code> was calling the method <code>check_submission_state()</code> and passing 'color' array. The method <code>check_submission_state()</code> was checking multiple parameters and was pushing certain colors into the array. The method <code>obtain_team_color()</code> was then returning the last element of the array to the method <code>team_color()</code> 
'''Problem:''' The color array being passed around was unclear and was an unrequired data structure. 
Code was as follows
<pre>
def team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at
# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)
# Returning color based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
obtain_team_color(response_map, assignment_created, assignment_due_dates)
end
else
'red'
end
end

# loops through the number of assignment review rounds and obtains the team color
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end

# checks the submission state within each round and assigns team color
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color.push 'green'
else
link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>
'''Solution:''' The color was changed to a variable, and on each check in the method check_submission_state(), the color variable is updated. 
Updated Code is as follows:
<pre>def team_color(response_map)
color = 'red'
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at
# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)
# Returning color based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).nil?
color = 'brown'
elsif response_for_each_round?(response_map)
color = 'blue'
else
color = obtain_team_color(response_map, assignment_created, assignment_due_dates)
end
color #returning the value of color
end
end

# loops through the number of assignment review rounds and obtains the team color
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = 'red' # assigning the color default to red
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color
end

# checks the submission state within each round and assigns team color
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color = 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color = 'green'
else
link_updated_at = get_link_updated_at(link)
color = link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>
'''Contributor:''' Rohan Shiveshwarkar
 
* '''Issue #3:''' Various method names are not Ruby-like. 
'''Methods involved:''' get_data_for_review_report(), get_team_color(), get_link_updated_at(), get_team_reviewed_link_name(), get_awarded_review_score(), get_each_review_and_feedback_response_map(), get_certain_review_and_feedback_response_map(), get_css_style_for_calibration_report() 
'''Initial Code:''' Same as methods involved above 
'''Problem:''' According to Ruby Style Guide, we should avoid prefixing method names with get_. 
'''Solution:''' I got rid of get_ on every method name which begins with get_. I also searched same methods which were used in other files, and also changed their names. 
'''Contributor:''' Gunju Im
 
* '''Issue #4:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 
* '''Issue #5:''' Generalizing the method sort_reviewer_by_review_volume_desc() 
'''Methods involved:''' <code>sort_reviewer_by_review_volume_desc()</code> 
'''Initial Code:''' The method was only taking into account the metric: review volume 
'''Problem:''' The Response has several other metrics to be considered including number of suggestions, or number of suggestions + number of problems detected 
Code was as follows 
'''review_mapping_helper.rb'''
<pre>def sort_reviewer_by_review_volume_desc
@reviewers.each do |r|
# get the volume of review comments
review_volumes = Response.volume_of_review_comments(@assignment.id, r.id)
r.avg_vol_per_round = []
review_volumes.each_index do |i|
if i.zero?
r.overall_avg_vol = review_volumes[0]
else
r.avg_vol_per_round.push(review_volumes[i])
end
end
end
# get the number of review rounds for the assignment
@num_rounds = @assignment.num_review_rounds.to_f.to_i
@all_reviewers_avg_vol_per_round = []
@all_reviewers_overall_avg_vol = @reviewers.inject(0) { |sum, r| sum + r.overall_avg_vol } / (@reviewers.blank? ? 1 : @reviewers.length)
@num_rounds.times do |round|
@all_reviewers_avg_vol_per_round.push(@reviewers.inject(0) { |sum, r| sum + r.avg_vol_per_round[round] } / (@reviewers.blank? ? 1 : @reviewers.length))
end
@reviewers.sort! { |r1, r2| r2.overall_avg_vol <=> r1.overall_avg_vol }
end
</pre>

'''_review_report.html.erb'''
<pre>

(Line 61) <% sort_reviewer_by_review_volume_desc.each_with_index do |reviewer, index| %>
</pre>

'''Solution:''' Created a generalized method <code>sort_reviewer_by_review_metric_desc()</code> which takes in a string parameter specifying the metric to be considered (eg. "review_volume") and edited the function call in <code>_review_report.html.erb</code> file and in <code>spec/helpers/review_mapping_helper_spec.rb</code> file 
Code is as follows: 
'''review_mapping_helper.rb'''
<pre>
# Generalized function which takes in string parameter specifying the metric to be sorted
def sort_reviewer_by_review_metric_desc(metric) #metric is the string value of the metric to be sorted with
if (metric.eql?("review_volume"))
@reviewers.each do |r|
# get the volume of review comments
review_volumes = Response.volume_of_review_comments(@assignment.id, r.id)
r.avg_vol_per_round = []
review_volumes.each_index do |i|
if i.zero?
r.overall_avg_vol = review_volumes[0]
else
r.avg_vol_per_round.push(review_volumes[i])
end
end
end

# get the number of review rounds for the assignment
@num_rounds = @assignment.num_review_rounds.to_f.to_i
@all_reviewers_avg_vol_per_round = []
@all_reviewers_overall_avg_vol = @reviewers.inject(0) { |sum, r| sum + r.overall_avg_vol } / (@reviewers.blank? ? 1 : @reviewers.length)
@num_rounds.times do |round|
@all_reviewers_avg_vol_per_round.push(@reviewers.inject(0) { |sum, r| sum + r.avg_vol_per_round[round] } / (@reviewers.blank? ? 1 : @reviewers.length))
end
@reviewers.sort! { |r1, r2| r2.overall_avg_vol <=> r1.overall_avg_vol }
end
end
</pre>

'''_review_report.html.erb'''
<pre>

(Line 61) <% sort_reviewer_by_review_metric_desc("review_volume").each_with_index do |reviewer, index| %>

</pre>
'''Contributor:''' Rohan Shiveshwarkar
 
* '''Issue #6:''' Refactor charts generating methods into another file as a helper/mixin 
'''Methods involved:''' <code>initialize_chart_elements()</code>, <code>display_volume_metric_chart()</code>, <code>display_tagging_interval_chart()</code>, <code>calculate_key_chart_information()</code> 
'''Initial Code:''' The methods above were included in the <code>review_mapping_helper.rb</code> file 
'''Problem:''' They are cohesive enough that they should be in their own separate file, either another helper or a mixin 
'''Solution:''' Created a new file <code>chart_generator_helper.rb</code> and created a new module <code>ChartGeneratorHelper</code> and shifted all the functions into that helper, and included it into the module <code>ReviewMappingHelper</code> in the <code>review_mapping_helper.rb</code> file 
The new code is organized as below 

'''chart_generator_helper.rb'''
<pre>
module ChartGeneratorHelper
def initialize_chart_elements()
def display_volume_metric_chart()
def display_tagging_interval_chart()
def calculate_key_chart_information()</pre>
 
'''review_mapping_helper.rb'''

<pre>
module ReviewMappingHelper
include ChartGeneratorHelper
...
...
...
...</pre>

'''Contributor:''' Rohan Shiveshwarkar
 

* '''Issue #7:''' A method list_review_submissions is not clear that it is needed. 
'''Methods involved:''' list_review_submissions 
'''Initial Code:''' def list_review_submissions(participant_id, reviewee_team_id, response_map_id)
participant = Participant.find(participant_id)
team = AssignmentTeam.find(reviewee_team_id)
html = ''
unless team.nil? || participant.nil?
review_submissions_path = team.path + '_review' + '/' + response_map_id.to_s
files = team.submitted_files(review_submissions_path)
html += display_review_files_directory_tree(participant, files) if files.present?
end
html.html_safe
end 
'''Problem:''' I can’t find its usage even though it is used in a view file; app/views/reports/_review_report.html.erb. 
'''Solution:''' I deleted the method in files; review_mapping_helper.rb and _review_report.html.erb. 

'''Contributor:''' Gunju Im
 
* '''Issue #8:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 
* '''Issue #9:''' Three classes which locate in the last part of file have no comments to explain what is being done. 
'''Methods involved:''' initialize(), reviews_per_team, reviews_needed, reviews_per_student 
'''Initial Code:''' class ReviewStrategy
attr_accessor :participants, :teams

def initialize(participants, teams, review_num)
@participants = participants
@teams = teams
@review_num = review_num
end
end

class StudentReviewStrategy < ReviewStrategy
def reviews_per_team
(@participants.size * @review_num * 1.0 / @teams.size).round
end

def reviews_needed
@participants.size * @review_num
end

def reviews_per_student
@review_num
end
end

class TeamReviewStrategy < ReviewStrategy
def reviews_per_team
@review_num
end

def reviews_needed
@teams.size * @review_num
end

def reviews_per_student
(@teams.size * @review_num * 1.0 / @participants.size).round
end
end 
'''Problem:''' Three classes are unclear. 
'''Solution:''' They are only used in this file. Also, they have methods that have same names with the other classes even if they are included in other class. At first, I tried to know what these classes meant and whether there was good way to refactor their method names. However, in conclusion, they are useless in the file, so I deleted them. 
'''Contributor:''' Gunju Im

==Peer Review Information==
For viewing the deployed project (on VCL) please click on this link -> http://152.7.177.222:8080/ 
And use the following credentials: Username = instructor6 | Password = password

==Test Cases==
===Rspec===
This is a refactoring project, so it is expected that the original functionality should be retained. All the test cases passed which implies that the refactored code did not break the existing functionality.
 
Proof of test cases being passed: 
[[File:Testpassedproof.png]]

==Github Links==
===Link to Expertiza Repository===
https://github.com/expertiza/expertiza 
===Link to Forked Repository===
https://github.com/RoninS28/expertiza-E2262 
===Link to Pull Request===
http://github.com/expertiza/expertiza/pull/2462

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:54:42Z

Rsshives:

==E2262. Further refactoring and improvement of review_mapping_helper==

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza is an all inclusive web service that allows instructors to create, edit and manage assignments. This includes the functionality for topic selection and team formation across various projects and assignments. Expertiza allows for a variety of submission types including URL and PDF. Expertiza also allows the instructor to assign peer reviews and team assessments.

==Team==
===Mentor===
Jialin Cui (jcui9 ncsu.edu)

===Team Members===
Gun Ju Im (gim@ncsu.edu) 
Rithik Jain (rjain25@ncsu.edu) 
Rohan Shiveshwarkar (rsshives@ncsu.edu) 

==Description of Project==

This wiki describes the work done in refactoring the review_mapping_helper.rb and associated files calling the methods contained in it. The main goal of the tasks was to make the code clearer and more understandable to the reader while retaining the functionality. The goal included inserting comments wherever necessary.

==File Description==

The review_mapping_helper has methods that help return charts and other graphical data to the frontend

==What is Needed==

This project builds on E2225, and should begin with the refactoring done by that project. That project focused on simplifying the methods in review_mapping_helper, while this project looks at making the code more understandable and transparent.

==Files Modified==

* app/helpers/review_mapping_helper.rb 
* app/views/reports/_calibration_report.html.erb
* app/views/reports/_feedback_report.html.erb
* app/views/reports/_review_report.html.erb
* app/views/reports/_team_score.html.erb
* app/views/reports/_team_score_score_awarded.html.erb
* spec/features/review_mapping_helper_spec.rb
* spec/helpers/review_mapping_helper_spec.rb

==Issues to be Addressed==

* method get_data_for_review_report marshals a lot of data together and passes back a data structure. It is used in views/reports/_review_report.html.erb, but it is quite difficult to see how the data is displayed. It violates the Expert pattern because the view needs to know how to break apart the structure that is passed to it. Doing the same thing with partials in views/reports would make the code easier to follow 
* The next three methods involve team “color”. Color coding is explained on this page and this page for the E1789 project and this page for E1815. The code for these methods is not at all clear and should be refactored. And please use the American spelling “color”. 
* Various method names begin with get. This is not Ruby-like. Change the names to something more appropriate. 
* get_awarded_review_score computes an overall score based on scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in response_map.rb. Contact Nicholas Himes (nnhimes@ncsu.edu) for particulars. Change this method to use the new code. 
* The method sort_reviewer_by_review_volume_desc should be generalized so that it can sort by any metric, not just review volume. Other metrics might include number of suggestions or number of suggestions + number of problems detected. This method should not be counting the number of review rounds! Since other places in the code will need to know the number of review rounds, it should be calculated somewhere else in the system. 
* The next several methods generate charts. They are cohesive enough that they should be in their own separate file, either another helper or a mixin. 
* Then there is a method list_review_submissions. It’s not at all clear that this method is needed, though it is used in one view. Look on the Expertiza wiki and see if there is a better way. 
* There are several methods for feedback_response_maps. It is not at all clear why they are here. Look on the Expertiza wiki for the documentation, and see if you can replace them by calls to other methods, or at least make it clearer what they are doing. 
* The file ends with three small classes being defined. There are no comments at all to explain what is being done. Look them up on the Expertiza wiki and refactor or comment them, whichever seems more appropriate. 

==Problems Tackled==

* '''Issue #1:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 

* '''Issue #2:''' The code was not clear to the reader 
'''Methods involved:''' <code>team_color()</code>, <code>obtain_team_color()</code>, <code>check_submission_state()</code> 
'''Initial Code:''' The method <code>obtain_team_color</code> was calling the method <code>check_submission_state()</code> and passing 'color' array. The method <code>check_submission_state()</code> was checking multiple parameters and was pushing certain colors into the array. The method <code>obtain_team_color()</code> was then returning the last element of the array to the method <code>team_color()</code> 
'''Problem:''' The color array being passed around was unclear and was an unrequired data structure. 
Code was as follows
<pre>
def team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at
# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)
# Returning color based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
obtain_team_color(response_map, assignment_created, assignment_due_dates)
end
else
'red'
end
end

# loops through the number of assignment review rounds and obtains the team color
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end

# checks the submission state within each round and assigns team color
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color.push 'green'
else
link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>
'''Solution:''' The color was changed to a variable, and on each check in the method check_submission_state(), the color variable is updated. 
Updated Code is as follows:
<pre>def team_color(response_map)
color = 'red'
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at
# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)
# Returning color based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).nil?
color = 'brown'
elsif response_for_each_round?(response_map)
color = 'blue'
else
color = obtain_team_color(response_map, assignment_created, assignment_due_dates)
end
color #returning the value of color
end
end

# loops through the number of assignment review rounds and obtains the team color
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = 'red' # assigning the color default to red
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color
end

# checks the submission state within each round and assigns team color
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color = 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color = 'green'
else
link_updated_at = get_link_updated_at(link)
color = link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>
'''Contributor:''' Rohan Shiveshwarkar
 
* '''Issue #3:''' Various method names are not Ruby-like. 
'''Methods involved:''' get_data_for_review_report(), get_team_color(), get_link_updated_at(), get_team_reviewed_link_name(), get_awarded_review_score(), get_each_review_and_feedback_response_map(), get_certain_review_and_feedback_response_map(), get_css_style_for_calibration_report() 
'''Initial Code:''' Same as methods involved above 
'''Problem:''' According to Ruby Style Guide, we should avoid prefixing method names with get_. 
'''Solution:''' I got rid of get_ on every method name which begins with get_. I also searched same methods which were used in other files, and also changed their names. 
'''Contributor:''' Gunju Im
 
* '''Issue #4:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 
* '''Issue #5:''' Generalizing the method sort_reviewer_by_review_volume_desc() 
'''Methods involved:''' <code>sort_reviewer_by_review_volume_desc()</code> 
'''Initial Code:''' The method was only taking into account the metric: review volume 
'''Problem:''' The Response has several other metrics to be considered including number of suggestions, or number of suggestions + number of problems detected 
Code was as follows 
'''review_mapping_helper.rb'''
<pre>def sort_reviewer_by_review_volume_desc
@reviewers.each do |r|
# get the volume of review comments
review_volumes = Response.volume_of_review_comments(@assignment.id, r.id)
r.avg_vol_per_round = []
review_volumes.each_index do |i|
if i.zero?
r.overall_avg_vol = review_volumes[0]
else
r.avg_vol_per_round.push(review_volumes[i])
end
end
end
# get the number of review rounds for the assignment
@num_rounds = @assignment.num_review_rounds.to_f.to_i
@all_reviewers_avg_vol_per_round = []
@all_reviewers_overall_avg_vol = @reviewers.inject(0) { |sum, r| sum + r.overall_avg_vol } / (@reviewers.blank? ? 1 : @reviewers.length)
@num_rounds.times do |round|
@all_reviewers_avg_vol_per_round.push(@reviewers.inject(0) { |sum, r| sum + r.avg_vol_per_round[round] } / (@reviewers.blank? ? 1 : @reviewers.length))
end
@reviewers.sort! { |r1, r2| r2.overall_avg_vol <=> r1.overall_avg_vol }
end
</pre>

'''_review_report.html.erb'''
<pre>

(Line 61) <% sort_reviewer_by_review_volume_desc.each_with_index do |reviewer, index| %>
</pre>

'''Solution:''' Created a generalized method <code>sort_reviewer_by_review_metric_desc()</code> which takes in a string parameter specifying the metric to be considered (eg. "review_volume") and edited the function call in <code>_review_report.html.erb</code> file and in <code>spec/helpers/review_mapping_helper_spec.rb</code> file 
Code is as follows: 
'''review_mapping_helper.rb'''
<pre>
# Generalized function which takes in string parameter specifying the metric to be sorted
def sort_reviewer_by_review_metric_desc(metric) #metric is the string value of the metric to be sorted with
if (metric.eql?("review_volume"))
@reviewers.each do |r|
# get the volume of review comments
review_volumes = Response.volume_of_review_comments(@assignment.id, r.id)
r.avg_vol_per_round = []
review_volumes.each_index do |i|
if i.zero?
r.overall_avg_vol = review_volumes[0]
else
r.avg_vol_per_round.push(review_volumes[i])
end
end
end

# get the number of review rounds for the assignment
@num_rounds = @assignment.num_review_rounds.to_f.to_i
@all_reviewers_avg_vol_per_round = []
@all_reviewers_overall_avg_vol = @reviewers.inject(0) { |sum, r| sum + r.overall_avg_vol } / (@reviewers.blank? ? 1 : @reviewers.length)
@num_rounds.times do |round|
@all_reviewers_avg_vol_per_round.push(@reviewers.inject(0) { |sum, r| sum + r.avg_vol_per_round[round] } / (@reviewers.blank? ? 1 : @reviewers.length))
end
@reviewers.sort! { |r1, r2| r2.overall_avg_vol <=> r1.overall_avg_vol }
end
end
</pre>

'''_review_report.html.erb'''
<pre>

(Line 61) <% sort_reviewer_by_review_metric_desc("review_volume").each_with_index do |reviewer, index| %>

</pre>
'''Contributor:''' Rohan Shiveshwarkar
 
* '''Issue #6:''' Refactor charts generating methods into another file as a helper/mixin 
'''Methods involved:''' <code>initialize_chart_elements()</code>, <code>display_volume_metric_chart()</code>, <code>display_tagging_interval_chart()</code>, <code>calculate_key_chart_information()</code> 
'''Initial Code:''' The methods above were included in the <code>review_mapping_helper.rb</code> file 
'''Problem:''' They are cohesive enough that they should be in their own separate file, either another helper or a mixin 
'''Solution:''' Created a new file <code>chart_generator_helper.rb</code> and created a new module <code>ChartGeneratorHelper</code> and shifted all the functions into that helper, and included it into the module <code>ReviewMappingHelper</code> in the <code>review_mapping_helper.rb</code> file 
The new code is organized as below 

'''chart_generator_helper.rb'''
<pre>
module ChartGeneratorHelper
def initialize_chart_elements()
def display_volume_metric_chart()
def display_tagging_interval_chart()
def calculate_key_chart_information()</pre>
 
'''review_mapping_helper.rb'''

<pre>
module ReviewMappingHelper
include ChartGeneratorHelper
...
...
...
...</pre>

'''Contributor:''' Rohan Shiveshwarkar
 

* '''Issue #7:''' A method list_review_submissions is not clear that it is needed. 
'''Methods involved:''' list_review_submissions 
'''Initial Code:''' def list_review_submissions(participant_id, reviewee_team_id, response_map_id)
participant = Participant.find(participant_id)
team = AssignmentTeam.find(reviewee_team_id)
html = ''
unless team.nil? || participant.nil?
review_submissions_path = team.path + '_review' + '/' + response_map_id.to_s
files = team.submitted_files(review_submissions_path)
html += display_review_files_directory_tree(participant, files) if files.present?
end
html.html_safe
end 
'''Problem:''' I can’t find its usage even though it is used in a view file; app/views/reports/_review_report.html.erb. 
'''Solution:''' I deleted the method in files; review_mapping_helper.rb and _review_report.html.erb. 

'''Contributor:''' Gunju Im
 
* '''Issue #8:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 
* '''Issue #9:''' Three classes which locate in the last part of file have no comments to explain what is being done. 
'''Methods involved:''' initialize(), reviews_per_team, reviews_needed, reviews_per_student 
'''Initial Code:''' class ReviewStrategy
attr_accessor :participants, :teams

def initialize(participants, teams, review_num)
@participants = participants
@teams = teams
@review_num = review_num
end
end

class StudentReviewStrategy < ReviewStrategy
def reviews_per_team
(@participants.size * @review_num * 1.0 / @teams.size).round
end

def reviews_needed
@participants.size * @review_num
end

def reviews_per_student
@review_num
end
end

class TeamReviewStrategy < ReviewStrategy
def reviews_per_team
@review_num
end

def reviews_needed
@teams.size * @review_num
end

def reviews_per_student
(@teams.size * @review_num * 1.0 / @participants.size).round
end
end 
'''Problem:''' Three classes are unclear. 
'''Solution:''' They are only used in this file. Also, they have methods that have same names with the other classes even if they are included in other class. At first, I tried to know what these classes meant and whether there was good way to refactor their method names. However, in conclusion, they are useless in the file, so I deleted them. 
'''Contributor:''' Gunju Im

==Peer Review Information==
For viewing the deployed project (on VCL) please click on this link -> http://152.7.99.156:8080 
And use the following credentials: Username = instructor6 | Password = password

==Test Cases==
===Rspec===
This is a refactoring project, so it is expected that the original functionality should be retained. All the test cases passed which implies that the refactored code did not break the existing functionality.
 
Proof of test cases being passed: 
[[File:Testpassedproof.png]]

==Github Links==
===Link to Expertiza Repository===
https://github.com/expertiza/expertiza 
===Link to Forked Repository===
https://github.com/RoninS28/expertiza-E2262 
===Link to Pull Request===
http://github.com/expertiza/expertiza/pull/2462

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:45:10Z

Rsshives:

==E2262. Further refactoring and improvement of review_mapping_helper==

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza is an all inclusive web service that allows instructors to create, edit and manage assignments. This includes the functionality for topic selection and team formation across various projects and assignments. Expertiza allows for a variety of submission types including URL and PDF. Expertiza also allows the instructor to assign peer reviews and team assessments.

==Team==
===Mentor===
Jialin Cui (jcui9 ncsu.edu)

===Team Members===
Gun Ju Im (gim@ncsu.edu) 
Rithik Jain (rjain25@ncsu.edu) 
Rohan Shiveshwarkar (rsshives@ncsu.edu) 

==Description of Project==

This wiki describes the work done in refactoring the review_mapping_helper.rb and associated files calling the methods contained in it. The main goal of the tasks was to make the code clearer and more understandable to the reader while retaining the functionality. The goal included inserting comments wherever necessary.

==File Description==

The review_mapping_helper has methods that help return charts and other graphical data to the frontend

==What is Needed==

This project builds on E2225, and should begin with the refactoring done by that project. That project focused on simplifying the methods in review_mapping_helper, while this project looks at making the code more understandable and transparent.

==Files Modified==

* app/helpers/review_mapping_helper.rb 
* app/views/reports/_calibration_report.html.erb
* app/views/reports/_feedback_report.html.erb
* app/views/reports/_review_report.html.erb
* app/views/reports/_team_score.html.erb
* app/views/reports/_team_score_score_awarded.html.erb
* spec/features/review_mapping_helper_spec.rb
* spec/helpers/review_mapping_helper_spec.rb

==Issues to be Addressed==

* method get_data_for_review_report marshals a lot of data together and passes back a data structure. It is used in views/reports/_review_report.html.erb, but it is quite difficult to see how the data is displayed. It violates the Expert pattern because the view needs to know how to break apart the structure that is passed to it. Doing the same thing with partials in views/reports would make the code easier to follow 
* The next three methods involve team “color”. Color coding is explained on this page and this page for the E1789 project and this page for E1815. The code for these methods is not at all clear and should be refactored. And please use the American spelling “color”. 
* Various method names begin with get. This is not Ruby-like. Change the names to something more appropriate. 
* get_awarded_review_score computes an overall score based on scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in response_map.rb. Contact Nicholas Himes (nnhimes@ncsu.edu) for particulars. Change this method to use the new code. 
* The method sort_reviewer_by_review_volume_desc should be generalized so that it can sort by any metric, not just review volume. Other metrics might include number of suggestions or number of suggestions + number of problems detected. This method should not be counting the number of review rounds! Since other places in the code will need to know the number of review rounds, it should be calculated somewhere else in the system. 
* The next several methods generate charts. They are cohesive enough that they should be in their own separate file, either another helper or a mixin. 
* Then there is a method list_review_submissions. It’s not at all clear that this method is needed, though it is used in one view. Look on the Expertiza wiki and see if there is a better way. 
* There are several methods for feedback_response_maps. It is not at all clear why they are here. Look on the Expertiza wiki for the documentation, and see if you can replace them by calls to other methods, or at least make it clearer what they are doing. 
* The file ends with three small classes being defined. There are no comments at all to explain what is being done. Look them up on the Expertiza wiki and refactor or comment them, whichever seems more appropriate. 

==Problems Tackled==

* '''Issue #1:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 

* '''Issue #2:''' The code was not clear to the reader 
'''Methods involved:''' <code>team_color()</code>, <code>obtain_team_color()</code>, <code>check_submission_state()</code> 
'''Initial Code:''' The method <code>obtain_team_color</code> was calling the method <code>check_submission_state()</code> and passing 'color' array. The method <code>check_submission_state()</code> was checking multiple parameters and was pushing certain colors into the array. The method <code>obtain_team_color()</code> was then returning the last element of the array to the method <code>team_color()</code> 
'''Problem:''' The color array being passed around was unclear and was an unrequired data structure. 
Code was as follows
<pre>
def team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at
# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)
# Returning color based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
obtain_team_color(response_map, assignment_created, assignment_due_dates)
end
else
'red'
end
end

# loops through the number of assignment review rounds and obtains the team color
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end

# checks the submission state within each round and assigns team color
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color.push 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color.push 'green'
else
link_updated_at = get_link_updated_at(link)
color.push link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>
'''Solution:''' The color was changed to a variable, and on each check in the method check_submission_state(), the color variable is updated. 
Updated Code is as follows:
<pre>def team_color(response_map)
color = 'red'
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at
# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)
# Returning color based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).nil?
color = 'brown'
elsif response_for_each_round?(response_map)
color = 'blue'
else
color = obtain_team_color(response_map, assignment_created, assignment_due_dates)
end
color #returning the value of color
end
end

# loops through the number of assignment review rounds and obtains the team color
def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = 'red' # assigning the color default to red
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color
end

# checks the submission state within each round and assigns team color
def check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
color = 'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? || (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
color = 'green'
else
link_updated_at = get_link_updated_at(link)
color = link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>
'''Contributor:''' Rohan Shiveshwarkar
 
* '''Issue #3:''' Various method names are not Ruby-like. 
'''Methods involved:''' get_data_for_review_report(), get_team_color(), get_link_updated_at(), get_team_reviewed_link_name(), get_awarded_review_score(), get_each_review_and_feedback_response_map(), get_certain_review_and_feedback_response_map(), get_css_style_for_calibration_report() 
'''Initial Code:''' Same as methods involved above 
'''Problem:''' According to Ruby Style Guide, we should avoid prefixing method names with get_. 
'''Solution:''' I got rid of get_ on every method name which begins with get_. I also searched same methods which were used in other files, and also changed their names. 
'''Contributor:''' Gunju Im
 
* '''Issue #4:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 
* '''Issue #5:''' Generalizing the method sort_reviewer_by_review_volume_desc() 
'''Methods involved:''' sort_reviewer_by_review_volume_desc() 
'''Initial Code:''' The method was only taking into account the metric: review volume 
'''Problem:''' The Response has several other metrics to be considered including number of suggestions, or number of suggestions + number of problems detected 
'''Solution:''' Created a generalized method sort_reviewer_by_review_metric_desc() which takes in a string parameter specifying the metric to be considered (eg. "review_volume") 
'''Contributor:''' Rohan Shiveshwarkar
 
* '''Issue #6:''' Refactor charts generating methods into another file as a helper/mixin 
'''Methods involved:''' <code>initialize_chart_elements()</code>, <code>display_volume_metric_chart()</code>, <code>display_tagging_interval_chart()</code>, <code>calculate_key_chart_information()</code> 
'''Initial Code:''' The methods above were included in the <code>review_mapping_helper.rb</code> file 
'''Problem:''' They are cohesive enough that they should be in their own separate file, either another helper or a mixin 
'''Solution:''' Created a new file <code>chart_generator_helper.rb</code> and created a new module <code>ChartGeneratorHelper</code> and shifted all the functions into that helper, and included it into the module <code>ReviewMappingHelper</code> in the <code>review_mapping_helper.rb</code> file 
The new code is organized as below 

'''chart_generator_helper.rb'''
<pre>
module ChartGeneratorHelper
def initialize_chart_elements()
def display_volume_metric_chart()
def display_tagging_interval_chart()
def calculate_key_chart_information()</pre>
 
'''review_mapping_helper.rb'''

<pre>
module ReviewMappingHelper
include ChartGeneratorHelper
...
...
...
...</pre>

'''Contributor:''' Rohan Shiveshwarkar
 

* '''Issue #7:''' A method list_review_submissions is not clear that it is needed. 
'''Methods involved:''' list_review_submissions 
'''Initial Code:''' def list_review_submissions(participant_id, reviewee_team_id, response_map_id)
participant = Participant.find(participant_id)
team = AssignmentTeam.find(reviewee_team_id)
html = ''
unless team.nil? || participant.nil?
review_submissions_path = team.path + '_review' + '/' + response_map_id.to_s
files = team.submitted_files(review_submissions_path)
html += display_review_files_directory_tree(participant, files) if files.present?
end
html.html_safe
end 
'''Problem:''' I can’t find its usage even though it is used in a view file; app/views/reports/_review_report.html.erb. 
'''Solution:''' I deleted the method in files; review_mapping_helper.rb and _review_report.html.erb. 

'''Contributor:''' Gunju Im
 
* '''Issue #8:''' <Insert> 
'''Methods involved:''' <Insert> 
'''Initial Code:''' <Insert> 
'''Problem:''' <Insert> 
'''Solution:''' <Insert> 
'''Contributor:''' <Insert>
 
* '''Issue #9:''' Three classes which locate in the last part of file have no comments to explain what is being done. 
'''Methods involved:''' initialize(), reviews_per_team, reviews_needed, reviews_per_student 
'''Initial Code:''' class ReviewStrategy
attr_accessor :participants, :teams

def initialize(participants, teams, review_num)
@participants = participants
@teams = teams
@review_num = review_num
end
end

class StudentReviewStrategy < ReviewStrategy
def reviews_per_team
(@participants.size * @review_num * 1.0 / @teams.size).round
end

def reviews_needed
@participants.size * @review_num
end

def reviews_per_student
@review_num
end
end

class TeamReviewStrategy < ReviewStrategy
def reviews_per_team
@review_num
end

def reviews_needed
@teams.size * @review_num
end

def reviews_per_student
(@teams.size * @review_num * 1.0 / @participants.size).round
end
end 
'''Problem:''' Three classes are unclear. 
'''Solution:''' They are only used in this file. Also, they have methods that have same names with the other classes even if they are included in other class. At first, I tried to know what these classes meant and whether there was good way to refactor their method names. However, in conclusion, they are useless in the file, so I deleted them. 
'''Contributor:''' Gunju Im

==Peer Review Information==
For viewing the deployed project (on VCL) please click on this link -> http://152.7.99.156:8080 
And use the following credentials: Username = instructor6 | Password = password

==Test Cases==
===Rspec===
This is a refactoring project, so it is expected that the original functionality should be retained. All the test cases passed which implies that the refactored code did not break the existing functionality.
 
Proof of test cases being passed: 
[[File:Testpassedproof.png]]

==Github Links==
===Link to Expertiza Repository===
https://github.com/expertiza/expertiza 
===Link to Forked Repository===
https://github.com/RoninS28/expertiza-E2262 
===Link to Pull Request===
http://github.com/expertiza/expertiza/pull/2462

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:40:26Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:38:50Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:37:38Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:36:28Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:35:06Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:33:59Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:33:03Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:32:00Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:31:21Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-11-06T03:29:28Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:49:51Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:34:14Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:33:38Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:31:28Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:30:35Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:22:28Z

Rsshives:

File:Testpassedproof.png

2022-10-27T03:21:52Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:19:31Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:18:13Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:16:55Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:15:45Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:14:52Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:08:34Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:05:22Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T03:04:32Z

Rsshives:

CSC/ECE 517 Fall 2022 - E2262: Refactor review mapping helper.rb

2022-10-27T02:05:43Z

Rsshives: Created page with "==E2262. Further refactoring and improvement of review_mapping_helper== This page provides a description of the Expertiza based OSS project. __TOC__ ===About Expertiza==..."

==E2262. Further refactoring and improvement of review_mapping_helper==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza is an all inclusive web service that allows instructors to create, edit and manage assignments. This includes the functionality for topic selection and team formation across various projects and assignments. Expertiza allows for a variety of submission types including URL and PDF. Expertiza also allows the instructor to assign peer reviews and team assessments.

CSC/ECE 517 Fall 2022

2022-10-27T02:04:04Z

Rsshives:

== OSS Projects ==

* [[CSC/ECE 517 Fall 2022 - E2253.Refactor delayed mailer.rb and scheduled task.rb]]
* [[CSC/ECE 517 Fall 2022 - E2256: Refactor late_policies_controller.rb]]
* [[CSC/ECE 517 Fall 2022 - E2258. Refactor submitted_content_controller]]
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]
* [[CSC/ECE 517 Fall 2022 - E2260. Refactor review_mapping_controller]]
* [[CSC/ECE 517 Fall 2022 - E2250. Refactor suggestion controller.rb]]
* [[CSC/ECE 517 Fall 2022 - E2255. Refactor student_quizzes_controller.rb]]
* [[CSC/ECE 517 Fall 2022 - E2255. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2022 - E2254: Refactor teams_controller.rb]]
* [[CSC/ECE 517 Fall 2022 - E2257: Refactor questionnaires_controller.rb]]
* [[CSC/ECE 517 Fall 2022 - E2262: Refactor review_mapping_helper.rb]]