Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2017/E1796. Unify Create Assignment and Edit Assignment pages

2017-11-15T04:02:18Z

Jjohn3: /* Approach */

E1796. Unify Create Assignment and Edit Assignment pages

===Introduction===
Expertiza is an open source project based on Ruby on Rails framework. It is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. Expertiza enables the instructor to create new and customize existing assignments. It also enables the instructor to create a list of topics the students can sign up for as part of a project. Students can form teams in Expertiza to work on various projects and assignments. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement:==
In the Expertiza portal presently when an instructor wants to create a new assignment then as he selects a new assignment option only a few metrics are asked for while for mentioning the other metrics the professor needs to edit assignment and then under that he is shown the options to edit all the other metrics. Also, when we press the save button while creating or editing an assignment it goes to HTML form request, instead it should be changed to AJAX request so that the page does not need to get refreshed every time user saves the changes. Few other minor issues are validating the user entries and fixing tooltips so that they are supported across all the browsers.( Chrome, Safari, Firefox etc.)

==Scope of this Project: ==
Specific Improvements to assignment creation by navigating the user for creating a new assignment to edit assignment page(view/assignment/edit_assignment).
 Making sure the edit assignment has blank fields in case of new assignment and saved fields in case of editing.
 When an Instructor creates a new assignment, he should be able to see a table to set DueDates, Review Strategy options and Rubrics associated with the assignments. These options are currently available to the instructor while editing an assignment. We will be adding options to be set during creation of new assignment. Fields to add suggested topics will be excluded for new assignment creation.
 Fixes to tooltips so that it is supported across all the browsers
 Change the save button to AJAX request instead of HTML form submission so that the page doesn’t need to get refreshed every time the user save the changes.

==Use Case Diagram:==

[[File:Assignment_use_case.png]]

==Current Flow:==
This page is displayed in the present system when a professor wants to create a new assignment as we can see there are only very few metrics on this page which are being displayed.

[[File:Picture2.png]]

While under Edit assignment the professor can now mention all the various metrics regarding the assignment on this page.

[[File:Picture1.png]]

=='''Approach==
New assignment creation form will render forms to set Due Dates, Review Strategy and Rubrics as a table. Currently application ID is required to edit these options for an application. We will modify application/views and application controller to support adding these options while creation without application ID without breaking existing edit functionality.

In the present implementation the save button is handled by JQuery but only until a point where necessary attribute checks are done. Now, we need to prevent the page from reloading which can be done by mentioning a remote value as true in the form tag for the edit assignment page.

In the improved view of New Assignment instructor will be able to specify details under four tabs as shown in the below screenshots
[[Image:New_View_New_Assignment_General.png]]

In the General tab the instructor is now able to see all the options from the old view.

[[Image:New_View_New_Assignment_Assign_Rubrics.png]]

In the improved view, in addition to supporting the General tab, now there are new tabs like "Rubrics".
This tab allows the instructor to select the various rubrics for the new assignment. This page also allows the setting of different rubrics for each round of the assignment.

[[Image:New_View_New_Assignment_Assign_Review_Strategy.png]]

In the improved view, there will be an additional new tab titled "Review Strategy".
This tab allows the instructor to set the various policies for review of the new assignment. This page also allows assigning manual review strategies.

[[Image:New_View_New_Assignment_Assign_DueDates.png]]

The new view also renders tab a titled "Due Dates" where the instructor can select the deadlines for various rounds of the selected rubrics. This tab also allows the instructor to select the late penalty policy
The instructor can also choose to make a new late policy instead of selecting an existing policy created by the same instructor.

=='''Design Pattern==
1.MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
 2.Dry Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

=='''Files to be Modified==
view/assignment/edit/.*
 views/assignment/new.html.erb
 views/assignment/*
 controller/assignment_controller.rb

=='''Test Plan==
Manual and automated testing to be done for below cases.
 As an Instructor, clicking on Manage->Assignments should display all created assignments with correct directory, creation date, updation date, instructor id, and actions.
 As an Instructor, clicking on Manage->Assignments->actions of an assignment should successfully redirect to action page.
 As an Instructor, clicking on Manage->Assignments->new public assignment,will redirected to "Create New Public Assignment" Page.
 As an Instructor, clicking on Manage->Assignments->new private assignment,will redirected to "Create New Private Assignment" Page.
 As an Instructor, clicking on Manage->Assignments->new public/private assignment, "Create New Public/Private Assignment" should render a table with tabs "General", "Rubrics, "Review Strategy", "Due Dates".
 As an Instructor, clicking on "Rubrics" tab from "Create New Public/Private Assignment" page, the tab should display table to select Questionnaire, menu type, display style, weight and notification limit.
 As an Instructor, select review type, author feedback type, and Teammate review option from the drop down from "Rubrics" tab.
 As an Instructor, select Review Strategy from drop down on "Rubrics" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of reviews done by each student on "Review Strategy" tab from "Create New Public/Private Assignment".
 As an Instructor, Set minimum number of reviews done for each submission on "Review Strategy" tab from "Create New Public/Private Assignment".
 As an Instructor, Set both calibrated and uncalibrated artifacts on "Review Strategy" tab.
 As an Instructor, select Anonymous Review option on "Review Strategy" tab.
 As an Instructor, select allow self review on "Review Strategy" tab.
 As an Instructor, set due dates on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of submissions allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of reviews allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of teammate review allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, after updating the fields on all tabs and clicking on save should create an assignment form in database.
 As an Instructor, after saving the new assignment, redirect to edit page to update Signup topics.
 As an instructor, save should not reload the page while creating a new assignment.
 Test when instructor creates a empty template for assignment form.
 Test when name of the assignment is not unique.
 Test when late policy is not created for instructor, and instructor tries to create a new assignment.
 All Users should be able to see tooltip of respective actions on all Browsers.
 As an instructor, delete an assignment.
 Form submission validates the attributes of all associated models.

CSC/ECE 517 Fall 2017/E1796. Unify Create Assignment and Edit Assignment pages

2017-11-15T03:55:43Z

Jjohn3: /* Improvements */

E1796. Unify Create Assignment and Edit Assignment pages

===Introduction===
Expertiza is an open source project based on Ruby on Rails framework. It is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. Expertiza enables the instructor to create new and customize existing assignments. It also enables the instructor to create a list of topics the students can sign up for as part of a project. Students can form teams in Expertiza to work on various projects and assignments. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement:==
In the Expertiza portal presently when an instructor wants to create a new assignment then as he selects a new assignment option only a few metrics are asked for while for mentioning the other metrics the professor needs to edit assignment and then under that he is shown the options to edit all the other metrics. Also, when we press the save button while creating or editing an assignment it goes to HTML form request, instead it should be changed to AJAX request so that the page does not need to get refreshed every time user saves the changes. Few other minor issues are validating the user entries and fixing tooltips so that they are supported across all the browsers.( Chrome, Safari, Firefox etc.)

==Scope of this Project: ==
Specific Improvements to assignment creation by navigating the user for creating a new assignment to edit assignment page(view/assignment/edit_assignment).
 Making sure the edit assignment has blank fields in case of new assignment and saved fields in case of editing.
 When an Instructor creates a new assignment, he should be able to see a table to set DueDates, Review Strategy options and Rubrics associated with the assignments. These options are currently available to the instructor while editing an assignment. We will be adding options to be set during creation of new assignment. Fields to add suggested topics will be excluded for new assignment creation.
 Fixes to tooltips so that it is supported across all the browsers
 Change the save button to AJAX request instead of HTML form submission so that the page doesn’t need to get refreshed every time the user save the changes.

==Use Case Diagram:==

[[File:Assignment_use_case.png]]

==Current Flow:==
This page is displayed in the present system when a professor wants to create a new assignment as we can see there are only very few metrics on this page which are being displayed.

[[File:Picture2.png]]

While under Edit assignment the professor can now mention all the various metrics regarding the assignment on this page.

[[File:Picture1.png]]

=='''Approach==
New assignment creation form will render forms to set Due Dates, Review Strategy and Rubrics. Currently application ID is required to edit these options for an application. We will modify application/views and application controller to support adding these options while creation without application ID without breaking existing edit functionality.

In the improved view of New Assignment instructor will be able to specify details under four tabs as shown in the below screenshots
[[Image:New_View_New_Assignment_General.png]]

In the General tab the instructor is now able to see all the options from the old view.

[[Image:New_View_New_Assignment_Assign_Rubrics.png]]

In the improved view, in addition to supporting the General tab, now there are new tabs like "Rubrics".
This tab allows the instructor to select the various rubrics for the new assignment. This page also allows the setting of different rubrics for each round of the assignment.

[[Image:New_View_New_Assignment_Assign_Review_Strategy.png]]

In the improved view, there will be an additional new tab titled "Review Strategy".
This tab allows the instructor to set the various policies for review of the new assignment. This page also allows assigning manual review strategies.

[[Image:New_View_New_Assignment_Assign_DueDates.png]]

=='''Design Pattern==
1.MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
 2.Dry Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

=='''Files to be Modified==
view/assignment/edit/.*
 views/assignment/new.html.erb
 views/assignment/*
 controller/assignment_controller.rb

=='''Test Plan==
Manual and automated testing to be done for below cases.
 As an Instructor, clicking on Manage->Assignments should display all created assignments with correct directory, creation date, updation date, instructor id, and actions.
 As an Instructor, clicking on Manage->Assignments->actions of an assignment should successfully redirect to action page.
 As an Instructor, clicking on Manage->Assignments->new public assignment,will redirected to "Create New Public Assignment" Page.
 As an Instructor, clicking on Manage->Assignments->new private assignment,will redirected to "Create New Private Assignment" Page.
 As an Instructor, clicking on Manage->Assignments->new public/private assignment, "Create New Public/Private Assignment" should render a table with tabs "General", "Rubrics, "Review Strategy", "Due Dates".
 As an Instructor, clicking on "Rubrics" tab from "Create New Public/Private Assignment" page, the tab should display table to select Questionnaire, menu type, display style, weight and notification limit.
 As an Instructor, select review type, author feedback type, and Teammate review option from the drop down from "Rubrics" tab.
 As an Instructor, select Review Strategy from drop down on "Rubrics" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of reviews done by each student on "Review Strategy" tab from "Create New Public/Private Assignment".
 As an Instructor, Set minimum number of reviews done for each submission on "Review Strategy" tab from "Create New Public/Private Assignment".
 As an Instructor, Set both calibrated and uncalibrated artifacts on "Review Strategy" tab.
 As an Instructor, select Anonymous Review option on "Review Strategy" tab.
 As an Instructor, select allow self review on "Review Strategy" tab.
 As an Instructor, set due dates on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of submissions allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of reviews allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of teammate review allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, after updating the fields on all tabs and clicking on save should create an assignment form in database.
 As an Instructor, after saving the new assignment, redirect to edit page to update Signup topics.
 As an instructor, save should not reload the page while creating a new assignment.
 Test when instructor creates a empty template for assignment form.
 Test when name of the assignment is not unique.
 Test when late policy is not created for instructor, and instructor tries to create a new assignment.
 All Users should be able to see tooltip of respective actions on all Browsers.
 As an instructor, delete an assignment.
 Form submission validates the attributes of all associated models.

File:New View New Assignment Assign DueDates.png

2017-11-15T03:54:58Z

Jjohn3: uploaded a new version of "File:New View New Assignment Assign DueDates.png"

New_View_New_Assignment_Assign_DueDates

File:New View New Assignment Assign DueDates.png

2017-11-15T03:53:51Z

Jjohn3: uploaded a new version of "File:New View New Assignment Assign DueDates.png": New_View_New_Assignment_Assign_DueDates

New_View_New_Assignment_Assign_DueDates

File:New View New Assignment Assign DueDates.png

2017-11-15T03:52:50Z

Jjohn3: uploaded a new version of "File:New View New Assignment Assign DueDates.png"

New_View_New_Assignment_Assign_DueDates

File:New View New Assignment Assign DueDates.png

2017-11-15T03:51:30Z

Jjohn3: uploaded a new version of "File:New View New Assignment Assign DueDates.png"

New_View_New_Assignment_Assign_DueDates

File:New View New Assignment Assign Review Strategy.png

2017-11-15T03:48:10Z

Jjohn3: uploaded a new version of "File:New View New Assignment Assign Review Strategy.png"

New_View_New_Assignment_Assign_Review_Strategy

File:New View New Assignment Assign Rubrics.png

2017-11-15T03:47:37Z

Jjohn3: uploaded a new version of "File:New View New Assignment Assign Rubrics.png"

New_View_New_Assignment_Assign_Rubrics

File:New View New Assignment Assign Review Strategy.png

2017-11-15T03:41:52Z

Jjohn3: uploaded a new version of "File:New View New Assignment Assign Review Strategy.png"

New_View_New_Assignment_Assign_Review_Strategy

File:New View New Assignment Assign Rubrics.png

2017-11-15T03:41:23Z

Jjohn3: uploaded a new version of "File:New View New Assignment Assign Rubrics.png"

New_View_New_Assignment_Assign_Rubrics

CSC/ECE 517 Fall 2017/E1796. Unify Create Assignment and Edit Assignment pages

2017-11-15T03:36:06Z

Jjohn3:

E1796. Unify Create Assignment and Edit Assignment pages

The current new assignment UI is a Rails based From, while the Assignment Edit Form is a multi level JavasScript based form (view/assignment/edit/.*) that consists of multiple inputs and user interactions. When an instructor creates a new assignment, there are only a limited parameters that he can set in the creation page, then (s)he needs to edit the assignment to define the rest of the parameters. This is confusing and needs to be unified. One solution could be ditching the new assignment form (views/assignment/new.html.erb)
===Introduction===
==Problem Statement:==
In the Expertiza portal presently when an instructor wants to create a new assignment then as he selects a new assignment option only a few metrics are asked for while for mentioning the other metrics the professor needs to edit assignment and then under that he is shown the options to edit all the other metrics. Also, when we press the save button while creating or editing an assignment it goes to HTML form request, instead it should be changed to AJAX request so that the page does not need to get refreshed every time user saves the changes. Few other minor issues are validating the user entries and fixing tooltips so that they are supported across all the browsers.( Chrome, Safari, Firefox etc.)

==Scope of this Project: ==
Specific Improvements to assignment creation by navigating the user for creating a new assignment to edit assignment page(view/assignment/edit_assignment).
 Making sure the edit assignment has blank fields in case of new assignment and saved fields in case of editing.
 When an Instructor creates a new assignment, he should be able to see a table to set DueDates, Review Strategy options and Rubrics associated with the assignments. These options are currently available to the instructor while editing an assignment. We will be adding options to be set during creation of new assignment. Fields to add suggested topics will be excluded for new assignment creation.
 Fixes to tooltips so that it is supported across all the browsers
 Change the save button to AJAX request instead of HTML form submission so that the page doesn’t need to get refreshed every time the user save the changes.

==Use Case Diagram:==

[[File:Assignment_use_case.png]]

==Current Flow:==
This page is displayed in the present system when a professor wants to create a new assignment as we can see there are only very few metrics on this page which are being displayed.

[[File:Picture2.png]]

While under Edit assignment the professor can now mention all the various metrics regarding the assignment on this page.

[[File:Picture1.png]]

=='''Improvements==
In the improved view of New Assignment instructor will be able to specify details under four tabs as shown in the below screenshots
[[Image:New_View_New_Assignment_General.png]]

In the General tab the instructor is now able to see all the options from the old view.

=='''Design Pattern==
1.MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
 2.Dry Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

=='''Files to be Modified==
view/assignment/edit/.*
 views/assignment/new.html.erb
 views/assignment/*
 controller/assignment_controller.rb

=='''Test Plan==
Manual and automated testing to be done for below cases.
 As an Instructor, clicking on Manage->Assignments should display all created assignments with correct directory, creation date, updation date, instructor id, and actions.
 As an Instructor, clicking on Manage->Assignments->actions of an assignment should successfully redirect to action page.
 As an Instructor, clicking on Manage->Assignments->new public assignment,will redirected to "Create New Public Assignment" Page.
 As an Instructor, clicking on Manage->Assignments->new private assignment,will redirected to "Create New Private Assignment" Page.
 As an Instructor, clicking on Manage->Assignments->new public/private assignment, "Create New Public/Private Assignment" should render a table with tabs "General", "Rubrics, "Review Strategy", "Due Dates".
 As an Instructor, clicking on "Rubrics" tab from "Create New Public/Private Assignment" page, the tab should display table to select Questionnaire, menu type, display style, weight and notification limit.
 As an Instructor, select review type, author feedback type, and Teammate review option from the drop down from "Rubrics" tab.
 As an Instructor, select Review Strategy from drop down on "Rubrics" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of reviews done by each student on "Review Strategy" tab from "Create New Public/Private Assignment".
 As an Instructor, Set minimum number of reviews done for each submission on "Review Strategy" tab from "Create New Public/Private Assignment".
 As an Instructor, Set both calibrated and uncalibrated artifacts on "Review Strategy" tab.
 As an Instructor, select Anonymous Review option on "Review Strategy" tab.
 As an Instructor, select allow self review on "Review Strategy" tab.
 As an Instructor, set due dates on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of submissions allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of reviews allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of teammate review allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, after updating the fields on all tabs and clicking on save should create an assignment form in database.
 As an Instructor, after saving the new assignment, redirect to edit page to update Signup topics.
 As an instructor, save should not reload the page while creating a new assignment.
 Test when instructor creates a empty template for assignment form.
 Test when name of the assignment is not unique.
 Test when late policy is not created for instructor, and instructor tries to create a new assignment.
 All Users should be able to see tooltip of respective actions on all Browsers.
 As an instructor, delete an assignment.

File:New View New Assignment General.png

2017-11-15T03:31:22Z

Jjohn3: uploaded a new version of "File:New View New Assignment General.png"

New_View_New_Assignment_General

CSC/ECE 517 Fall 2017/E1796. Unify Create Assignment and Edit Assignment pages

2017-11-15T03:27:21Z

Jjohn3:

E1796. Unify Create Assignment and Edit Assignment pages

The current new assignment UI is a Rails based From, while the Assignment Edit Form is a multi level JavasScript based form (view/assignment/edit/.*) that consists of multiple inputs and user interactions. When an instructor creates a new assignment, there are only a limited parameters that he can set in the creation page, then (s)he needs to edit the assignment to define the rest of the parameters. This is confusing and needs to be unified. One solution could be ditching the new assignment form (views/assignment/new.html.erb)
===Introduction===
==Problem Statement:==
In the Expertiza portal presently when an instructor wants to create a new assignment then as he selects a new assignment option only a few metrics are asked for while for mentioning the other metrics the professor needs to edit assignment and then under that he is shown the options to edit all the other metrics. Also, when we press the save button while creating or editing an assignment it goes to HTML form request, instead it should be changed to AJAX request so that the page does not need to get refreshed every time user saves the changes.

==Scope of this Project: ==
Specific Improvements to assignment creation by navigating the user for creating a new assignment to edit assignment page(view/assignment/edit_assignment).
Making sure the edit assignment has blank fields in case of new assignment and saved fields in case of editing.
Fixes to tooltips so that it is supported across all the browsers
Change the save button to AJAX request instead of HTML form submission so that the page doesn’t need to get refreshed every time the user save the changes.

==Use Case Diagram:==

[[File:Assignment_use_case.png]]

==Current Flow:==
This page is displayed in the present system when a professor wants to create a new assignment as we can see there are only very few metrics on this page which are being displayed.

[[File:Picture2.png]]

While under Edit assignment the professor can now mention all the various metrics regarding the assignment on this page.

[[File:Picture1.png]]

=='''Improvements==

=='''Design Pattern==
1.MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
 2.Dry Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

=='''Files to be Modified==
view/assignment/edit/.*
 views/assignment/new.html.erb
 views/assignment/*
 controller/assignment_controller.rb

=='''Test Plan==
Manual and automated testing to be done for below cases.
 As an Instructor, clicking on Manage->Assignments should display all created assignments with correct directory, creation date, updation date, instructor id, and actions.
 As an Instructor, clicking on Manage->Assignments->actions of an assignment should successfully redirect to action page.
 As an Instructor, clicking on Manage->Assignments->new public assignment,will redirected to "Create New Public Assignment" Page.
 As an Instructor, clicking on Manage->Assignments->new private assignment,will redirected to "Create New Private Assignment" Page.
 As an Instructor, clicking on Manage->Assignments->new public/private assignment, "Create New Public/Private Assignment" should render a table with tabs "General", "Rubrics, "Review Strategy", "Due Dates".
 As an Instructor, clicking on "Rubrics" tab from "Create New Public/Private Assignment" page, the tab should display table to select Questionnaire, menu type, display style, weight and notification limit.
 As an Instructor, select review type, author feedback type, and Teammate review option from the drop down from "Rubrics" tab.
 As an Instructor, select Review Strategy from drop down on "Rubrics" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of reviews done by each student on "Review Strategy" tab from "Create New Public/Private Assignment".
 As an Instructor, Set minimum number of reviews done for each submission on "Review Strategy" tab from "Create New Public/Private Assignment".
 As an Instructor, Set both calibrated and uncalibrated artifacts on "Review Strategy" tab.
 As an Instructor, select Anonymous Review option on "Review Strategy" tab.
 As an Instructor, select allow self review on "Review Strategy" tab.
 As an Instructor, set due dates on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of submissions allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of reviews allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, set number of teammate review allowed on "Due Date" tab from "Create New Public/Private Assignment".
 As an Instructor, after updating the fields on all tabs and clicking on save should create an assignment form in database.
 As an Instructor, after saving the new assignment, redirect to edit page to update Signup topics.
 As an instructor, save should not reload the page while creating a new assignment.
 Test when instructor creates a empty template for assignment form.
 Test when name of the assignment is not unique.
 Test when late policy is not created for instructor, and instructor tries to create a new assignment.
 All Users should be able to see tooltip of respective actions on all Browsers.
 As an instructor, delete an assignment.

File:New View New Assignment Assign DueDates.png

2017-11-15T03:13:51Z

Jjohn3: New_View_New_Assignment_Assign_DueDates

New_View_New_Assignment_Assign_DueDates

File:New View New Assignment Assign Review Strategy.png

2017-11-15T03:13:29Z

Jjohn3: New_View_New_Assignment_Assign_Review_Strategy

New_View_New_Assignment_Assign_Review_Strategy

File:New View New Assignment Assign Rubrics.png

2017-11-15T03:12:59Z

Jjohn3: New_View_New_Assignment_Assign_Rubrics

New_View_New_Assignment_Assign_Rubrics

File:New View New Assignment General.png

2017-11-15T03:12:38Z

Jjohn3: New_View_New_Assignment_General

New_View_New_Assignment_General

File:Current View New Assignment.png

2017-11-15T03:11:58Z

Jjohn3: Current_View_New_Assignment

Current_View_New_Assignment

CSC/ECE 517 Fall 2017

2017-11-08T01:17:50Z

Jjohn3:

'''Design Project Documentation'''
*[[CSC/ECE 517 Fall 2017/E17A2 Lightweight Badging System]]
*[[CSC/ECE 517 Fall 2017/E17A8. Use a profiler to identify the problems / pages that take some time to load & fix them]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join]]
*[[CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]]
*[[CSC/ECE 517 Fall 2017/E17A0 Team-based reviewing]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join_Team1964]]
*[[CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement]]
*[[CSC/ECE 517 Fall 2017/E1799 Improve self-review Link peer review & self-review to derive grades]]
*[[CSC/ECE_517_Fall_2017/E1797_Timestamps_for_students_submissions]]
*[[CSC/ECE_517_Fall_2017/E17A1|CSC/ECE_517_Fall_2017/E17A1 - Let experts as well as students do reviews]]
*[[CSC/ECE_517_Fall_2017/M1753_OffscreenCanvas]]
*[[CSC/ECE 517 Fall 2017/M1754_Mutation_Testing]]
*[[CSC/ECE 517 Fall 2017/E1794. Student-generated questions added to rubric]]
*[[CSC/ECE 517 Fall 2017/E17A6. Fix account creation over web to work reasonably]]
*[[CSC/ECE 517 Fall 2017/E1792 OSS Visualizations for instructors]]
*[[CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment_Team34]]
*[[CSC/ECE 517 Fall 2017/E17A7_Allow_Reviewers_to_bid_on_what_to_review]]
*[[CSC/ECE 517 Fall 2017/E17A9 Lazy loading (infinite scroll) for assignments courses questionnaires and user lists with Jscroll]]
*[[CSC/ECE 517 Fall 2017/E1796. Unify Create Assignment and Edit Assignment pages]]

'''Writing Assignment 2'''
*[[CSC/ECE 517 Fall 2017/E1779. Fix teammate advertisements and requests to join a team]]
*[[CSC/ECE_517_Fall_2017/E1773 Investigate and Fix Expertiza Production Version Runtime Exceptions.rb]]
*[[CSC/ECE_517_Fall_2017/E1774 Metareview fixes and improvements.rb]]
*[[CSC/ECE_517_Fall_2017/E1788 OSS project Maroon Heatmap fixes]]
*[[CSC/ECE 517 Fall 2017/E1781 Topic Management]]
*[[CSC/ECE_517_Fall_2017/E1745_Refactor_response_controller.rb]]
*[[CSC/ECE_517_Fall_2017/E1752 Refactor assignments controller]]
*[[CSC/ECE_517_Fall_2017/E1776_Enhance_Imports]]
*[[CSC/ECE_517_Fall_2017/E1756 TLD Refactor response.rb]]
*[[CSC/ECE_517_Fall_2017/E1772_Refactor reputation_web_service_controller.rb]]
*[[CSC/ECE_517_Fall_2017/M1753_OffscreenCanvas API]]
*[[CSC/ECE_517_Fall_2017/M1754_Mutation Testing on Servo]]
*[[CSC/ECE_517_Fall_2017/E1753 OSS project bidding tests]]
*[[CSC/ECE_517_Fall_2017/E1766_Test team functionality]]
*[[CSC/ECE 517 Fall 2017/E1767 Improve imports]]
*[[CSC/ECE_517_Fall_2017/E1786_OSS project Juniper Bookmark Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1787_OSS project Bronze Score calculations]]
*[[CSC/ECE_517_Fall_2017/E1763 Fix Staggered-Deadline Assignments]]
*[[CSC/ECE 517 Fall 2017/E1757 Introduce a Student View for instructors]]
*[[CSC/ECE 517 Fall 2017/E1769_Refactor assignment_form.rb]]
*[[CSC/ECE 517 Fall 2017/E1754_Feature_test_of_rubric_advice]]
*[[CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories]]
*[[CSC/ECE 517 Fall 2017/E1748 Add past-due assignments to task list]]
*[[CSC/ECE 517 Fall 2017/E1761 Test First Development Refactor assignment.rb]]
*[[CSC/ECE_517_Fall_2017/E1780_OSS_Project_Teal_Email_Notification_Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1762 Test various kinds of response-map hierarchies]]
*[[CSC/ECE_517_Fall_2017/E1759 ]]
*[[CSC/ECE_517_Fall_2017/E1749_Test First Development Refactor questionnaire_controller.rb]]
*[[CSC/ECE 517 Fall 2017/E1777 Coherent specification of review requirements.rb]]
*[[CSC/ECE 517 Fall 2017/E1771_Refactor_team.rb]]
*[[CSC/ECE 517 Fall 2017/E1784 Fix mass assignments reported by Brakeman.rb]]

CSC/ECE 517 Fall 2017/E1796. Unify Create Assignment and Edit Assignment pages

2017-11-08T01:17:28Z

Jjohn3: Created page with "E1796. Unify Create Assignment and Edit Assignment pages The current new assignment UI is a Rails based From, while the Assignment Edit Form is a multi level JavasScript based f..."

CSC/ECE 517 Fall 2017/E1765 Rubrics.rb

2017-10-28T02:28:35Z

Jjohn3: /* E1765. OSS project Brown: Rubrics */

==E1765. OSS project Brown: Rubrics==

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. The Expertiza project is software to create reusable learning objects through peer review. It is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. Expertiza enables the instructor to create new and customize existing assignments. It also enables the instructor to create a list of topics the students can sign up for as part of a project. Students can form teams in Expertiza to work on various projects and assignments. Expertiza supports submission across various document types, including the URLs and wiki pages.

===About Questionnaires Controller===
This class manages the questions attached to a questionnaire. It enables the creation of new questionnaires, and editing of existing questionnaires. The questions attached to the questionnaire can either be added/updated manually from the user interface or imported from an existing comma separated file. Once the questions are added/updated satisfactorily, they can be exported as a comma separated file. The controller currently has its own import and export methods to achieve this functionality.

====Problem Statement====
The following tasks were accomplished in this project:

* Fixed Issue [https://github.com/expertiza/expertiza/issues/696 696]: Instructors can make changes to each others' rubric, which should not happen
* Updated action_allowed for access_control to prevent unauthorized access of methods..
* Implemented new feature [https://github.com/expertiza/expertiza/issues/577 577]: Dumping and loading rubric criterion from CSV
* Refactored Questionnaires Controller to use existing Import and Export controllers.
* Added import method in Questions model to enable creation of questions from CSV.

====Current Implementation====

=====Functionality=====
* Any user irrespective of his/ her privileges can edit the questionnaire.
::The questionnaire should be restricted to be editable only by an instructor, administrator, or a super administrator. Furthermore, an existing questionnaire should be restricted to be editable only by the instructor who created the questionnaire in the first place.
* Import and Export functionality in the Questionnaires Controller
::The current implementation of the Questionnaires controller uses its own import and export methods. The Questionnaires controller should instead use the import and export implemented for the intended purpose. This promotes separation of concerns and code reuse.

=====Drawbacks and Solutions=====
* '''Problem 1''': An instructor can change others' review rubrics.
::The method action_allowed in Questionnaires controller returns true for any user role for all actions.
<pre>
def action_allowed?
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant', 'Student'].include? current_role_name
end
</pre>
* '''Solution''': The implementation has been changed in such a way that the restriction on who is allowed to edit an existing rubric is as follows:
**A super administrator can edit any existing rubric.
**An administrator can edit any existing rubric.
**An instructor can only edit an existing rubric if it was created by him or her. An instructor cannot edit a rubric created by another instructor.
**The other functionalities have been left as it is, assuming that any user can create, view, etc. a new or existing rubric.

* '''Problem 2''': TODO: Add import/export problem
::The feature to allow importing Questions from files and exporting the questions had been broken since the refactoring of Questionnaire controller in [https://github.com/expertiza/expertiza/issues/577 summer 2015].

* '''Solution''': Solution
**The export file and import file views have to be enhanced to allow import/export of questions.
**Questionnaire edit view will have to be enhanced to render the export_file/start and import_file/start views which would support importing questions from and importing questions to CSV files.

====Enhancements====
*The action_allowed? method in Questionnaires controller has been modified to check for separate roles based on the action:
** If the action is edit, it checks that the user is a super administrator, an administrator, or an instructor who created the questionnaire in the first place.
** Else, all users are allowed to perform the action. (Assuming that even a student is allowed to add a questionnaire such as polls, surveys, etc)

<pre>
def action_allowed?
if action_name == "edit"
@questionnaire = Questionnaire.find(params[:id])
(['Super-Administrator',
'Administrator'
].include? current_role_name) ||
((['Instructor'].include? current_role_name) && current_user_id?( @questionnaire.instructor_id))
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant', 'Student'].include? current_role_name
end
end
</pre>

*Integrating export_file and import_file section with the questionnaire view allows questions to be imported into system from file, example CSV file and also to export question entries from system into an external file.
*The export_file and import_file views are now partial rendered as part of the edit questionnaire view.
<pre>
<%= link_to 'Import Questionnaire', :controller=>'import_file', :action=>'start', :model => 'Question', :id=> @questionnaire.id, :expected_fields => 'txt, type ,seq,size, break_before' %>|
<%= link_to 'Export Questionnaire', :controller=>'export_file',:action=>'start',:model=> 'Question',:id=> @questionnaire.id %>
</pre>

=====Code improvements=====
TODO: If any

====Automated Testing using RSPEC====
TODO: If any

====Testing from UI====
TODO: Get proper steps with user name and password
Following are a few testcases with respect to our code changes that can be tried from UI:
1. Log in as instructor 1 and create a new rubric.

2. Log in as another instructor. Go to [ Edit] page for the rubric and try to edit the questions.

3. Re log in as a student. Go to [ Edit] page for the rubric and try to edit the questions.

3. Re log in as instructor 1. Go to [ Edit] page for the rubric and try to edit the questions.

4. Re log in as a super administrator / admininstrator. Go to [ Edit] page for the rubric and try to edit the questionnaire.

5. "Export" button can be used to export all the questions and its associated details from the current questionnaire into a csv file that would named with the name of the questionnaire.

6. Choose the file that contains the questions to be imported into the questionnaire and press "Import" button to import the details into questionnaire.
*The columns expected in the csv file would be displayed in the same page in the expected order.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/akshayjain114/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[ Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2017/E1765 Rubrics.rb

2017-10-27T19:33:52Z

Jjohn3:

==E1765. OSS project Brown: Rubrics==

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. The Expertiza project is software to create reusable learning objects through peer review. It is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. Expertiza enables the instructor to create new and customize existing assignments. It also enables the instructor to create a list of topics the students can sign up for as part of a project. Students can form teams in Expertiza to work on various projects and assignments. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
The following tasks were accomplished in this project:

* Fixed Issue [https://github.com/expertiza/expertiza/issues/696 696]: Instructors can make changes to each others' rubric, which should not happen
* Updated action_allowed for access_control to prevent unauthorized access of methods..
* Implemented new feature [https://github.com/expertiza/expertiza/issues/577 577]: Dumping and loading rubric criterion from CSV
* Refactored Questionnaires Controller to use existing Import and Export controllers.
* Added import method in Questions model to enable creation of questions from CSV.

====About Questionnaires Controller====
This class manages the questions attached to a questionnaire. It enables the creation of new questionnaires, and editing of existing questionnaires. The questions attached to the questionnaire can either be added/updated manually from the user interface or imported from an existing comma separated file. Once the questions are added/updated satisfactorily, they can be exported as a comma separated file. The controller currently has its own import and export methods to achieve this functionality.

====Current Implementation====

======Functionality======
* Any user irrespective of his/ her privileges can edit the questionnaire.
::The questionnaire should be restricted to be editable only by an instructor, administrator, or a super administrator. Furthermore, an existing questionnaire should be restricted to be editable only by the instructor who created the questionnaire in the first place.
* Import and Export functionality in the Questionnaires Controller
::The current implementation of the Questionnaires controller uses its own import and export methods. The Questionnaires controller should instead use the import and export implemented for the intended purpose. This promotes separation of concerns and code reuse.

======Drawbacks and Solutions======
* '''Problem 1''': An instructor can change others' review rubrics.
::The method action_allowed in Questionnaires controller returns true for any user role for all actions.
<pre>
def action_allowed?
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant', 'Student'].include? current_role_name
end
</pre>
* '''Solution''': The implementation has been changed in such a way that the restriction on who is allowed to edit an existing rubric is as follows:
**A super administrator can edit any existing rubric.
**An administrator can edit any existing rubric.
**An instructor can only edit an existing rubric if it was created by him or her. An instructor cannot edit a rubric created by another instructor.
**The other functionalities have been left as it is, assuming that any user can create, view, etc. a new or existing rubric.

* '''Problem 2''': TODO: Add import/export problem
::The feature to allow importing Questions from files and exporting the questions had been broken since the refactoring of Questionnaire controller in [https://github.com/expertiza/expertiza/issues/577 summer 2015].
* '''Solution''': Solution

====New Implementation====
*The action_allowed? method in Questionnaires controller has been modified to check for separate roles based on the action:
** If the action is edit, it checks that the user is a super administrator, an administrator, or an instructor who created the questionnaire in the first place.
** Else, all users are allowed to perform the action. (Assuming that even a student is allowed to add a questionnaire such as polls, surveys, etc)

<pre>
def action_allowed?
if action_name == "edit"
@questionnaire = Questionnaire.find(params[:id])
(['Super-Administrator',
'Administrator'
].include? current_role_name) ||
((['Instructor'].include? current_role_name) && current_user_id?( @questionnaire.instructor_id))
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant', 'Student'].include? current_role_name
end
end
</pre>

* TODO: Add new implementation for import/export functionality.

====Code improvements====
TODO: If any

===Automated Testing using RSPEC===
TODO: If any

===Testing from UI===
TODO: Get proper steps with user name and password
Following are a few testcases with respect to our code changes that can be tried from UI:
1. Log in as instructor 1 and create a new rubric.

2. Log in as another instructor. Go to [ Edit] page for the rubric and try to edit the questions.

3. Re log in as a student. Go to [ Edit] page for the rubric and try to edit the questions.

3. Re log in as instructor 1. Go to [ Edit] page for the rubric and try to edit the questions.

4. Re log in as a super administrator / admininstrator. Go to [ Edit] page for the rubric and try to edit the questions.

5. TODO: Add steps for import/export reuse

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/akshayjain114/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[ Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin