View source for E1936 Specialized Rubrics REVISION

This wiki page describes the work and goals that have been completed and achieved while implementing Expertiza Project "''E1936. Specialized Rubrics for Different Topic Types (e.g., Servo project, refactoring project)''" for the CSC/ECE 517 "Object-Oriented Design and Development" class, in the Spring semester of the 2019.

__TOC__

== Introduction ==
This Wiki page is created per CSC/ECE 517: "Object-Oriented Design and Development", Expertiza Project requirements (Spring, 2019).

Our [http://wiki.expertiza.ncsu.edu/index.php/E1936_Specialized_Rubrics#Team team] was assigned the project "[https://docs.google.com/document/d/1Ozw2Bj2u_LyeKUdDqAyQtz1stEIKrxkmRnwmNyUgmzw/edit#heading=h.z86zstcoj6u7 E1936. Specialized rubrics for different topic types (e.g., Servo project, refactoring project)]".  This is an Expertiza project.

In this wiki page we describe the problem to be solved, how we solve that problem, and how we test our solution.  We also provide helpful links and contact information for our team.

== Project Description ==

In this section, we discuss the problem we need to solve, the Expertiza feature this problem is related to, what needs to be done to solve the problem (at a high level), and the previous attempt to solve this problem.

=== Problem Statement ===

This problem statement summarizes the problem as described in the project description "[https://docs.google.com/document/d/1Ozw2Bj2u_LyeKUdDqAyQtz1stEIKrxkmRnwmNyUgmzw/edit#heading=h.z86zstcoj6u7 E1936. Specialized rubrics for different topic types (e.g., Servo project, refactoring project)]".

In CSC/ECE 517, there are several types of topics that could be covered in a single class assignment.
* Code base
** Expertiza
** Mozilla
** etc.
* Goal
** Refactoring
** Testing
** etc.
However, currently we can only specify one kind of rubric for an assignment.  This means that teams working on different topics will be evaluated using the same rubric.  With this setup, it's not possible to fine-tune rubrics for different topics - rubrics tend to be overly general.

=== Feature Description ===

The Expertiza project already has a feature that allows rubrics to vary by project phase or "round".  The feature we will add in this project is a feature to allow rubrics to vary not only by round, but also by topic.  This allows more flexibility to the instructor when setting up an assignment, so that they can use rubrics better suited to the tasks that students are performing in an assignment.

When this feature is complete, the following scenarios will be possible, and the instructor will be the judge of which scenario is the best fit to the assignment:

* Rubric does not vary by round or by topic.
* Rubric varies by round, but not by topic.
* Rubric varies by topic, but not by round.
* Rubric varies by both round and topic.

=== What Needs to be Done ===

This section summarizes the work as described in the project description "[https://docs.google.com/document/d/1Ozw2Bj2u_LyeKUdDqAyQtz1stEIKrxkmRnwmNyUgmzw/edit#heading=h.z86zstcoj6u7 E1936. Specialized rubrics for different topic types (e.g., Servo project, refactoring project)]".

* In assignment#edit page "Rubrics" tab, add a checkbox to specify whether rubric should vary by topic.
* In assignment#edit page "Topics" tab, add dropdown(s) next to each topic to specify which rubric(s) are associated with the topic.
** The dropdown(s) should appear only if rubric should vary by topic, per the Rubrics tab.
** The topic should have a multiple dropdowns (one for each round) only if rubrics vary by round, per the Rubrics tab.
** By default, the rubric(s) for each course project will be the one(s) specified in “Rubrics” tab.
** The dropdown value can overwrite the default rubric.
* Be careful when making changes to the code
** The signup_sheet_controller should have as little to do as possible with the selection of rubrics.
** Anything not germane to selecting topics should be in another controller or (more probably) a helper.
* Create a DB migration to allow rubric to vary by topic as well as by round.

==== Screenshots ====
'''Current screenshot of Rubrics tab for an Assignment'''
(need to add a checkbox to indicate that rubric should vary by topic)

[[File:E1936 Screenshot Assignment Edit Rubrics.png]]


'''Current screenshot of Topics tab for an Assignment'''
(need to add a way to select rubrics for particular topics)

[[File:E1936 Screenshot Assignment Edit Topics.png]]



'''Proposed screenshot of Rubrics tab for an Assignment'''

[[File:E1936 Specialized Rubric rubric checkbox.png]]


'''Proposed screenshot of Topics tab for an Assignment'''

(drop down shown for only one topic here, but final product will have one for each topic)

[[File:E1936 Specialized Rubric dropdown menu.png]]

== Previous Work ==

There was previous attempt to implement this project in the Fall of 2018 semester by different team, but it was rejected due to several reasons. Our team was provided with all relevant information and materials about the design and implementation of the previously attempted project. We would like to acknowledge that we use previous implementation and design as reference and our starting point for our own implementation. The following is the list of links with the relevant materials that we have used for better project understanding, determining pros and cons of previously proposed changes, and establishing our design strategy and implementation:

# [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1873_Specialized_rubics_for_different_topic_types Wiki]
# [https://github.com/expertiza/expertiza/pull/1327 Pull Request]
# [https://drive.google.com/file/d/1UrLb0Ula_Lb_F4MOrdC-s6xng6B08VYu/view Video Demo]

After reviewing all relevant materials above, we concluded that the project implementation was incomplete and proposed design had significant flaw. 
We identified main drawbacks and flaw as follows:

* Establishing incorrect ''many-to-one'' relationship between ''sign_up_topics'' and ''questionnaires'' tables:
** Creating a DB migration to add ''questionnaire_id'' in the ''sign_up_topics'' table to store the dropdown data presumes ''one-to-one'' or ''many-to-one'' relationship between ''sign_up_topics'' and ''questionnaires'' tables
** Correct relationship between ''sign_up_topics'' and ''questionnaires'' tables is ''many-to-many''. For example, each project topic may have various rubrics depending on the round it is used (e.g., for round 1, topic may have one rubric; but for round 2, the same topic may have different rubric)
** Proposed previous migration changes would break DB design and would not allow to store correctly topic and its associated rubric per different round.
* Per project requirement specifications, "''The dropdown box should appear only if 'Vary rubric by topic' is selected in the Rubrics tab.''" This requirement was not met and ''Vary rubric by topic'' checkbox in the Rubrics tab was not implemented. Therefore, dropdown box with the list of rubrics appears regardless of whether "''Vary rubric by topic''" is selected or not.
* The dropdown box includes the list of all possible rubrics including default value. However, this condition can be improved. The dropdown box should list the rubrics that were created by the current user (professor who is logged in). This would allow to shorten the list of possible rubrics dramatically and help to avoid any misunderstanding and confusion while user selects desired rubric for the course project.

We found no further issues with the rest implementation and in other project materials. Wiki page is very useful for understanding design of proposed changes, finding drawbacks and the flaw. Considering all the pros and cons, and taking into account drawbacks of the proposed changes, our team evolved different approach that should successfully solve the problem stated for the project without without creating additional issues. Please see our [http://wiki.expertiza.ncsu.edu/index.php?title=E1936_Specialized_Rubrics#Project_Implementation Project Implementation] for more details.

== Previous Project Requirements ==

The project requirements originally specified how to alter the databases to support varying rubrics by topic.

''Create a new table named topic_questionnaires with field:''
* ''id''
* ''topic_id''
* ''questionnaire_id''
* ''used_in_round''

However, the E1936 team successfully petitioned for this requirement to change to give us more freedom in the implementation.  The original suggestion had a flaw.  There is already an existing table in the Expertiza project called ''assignment_questionnaires'', which has columns including ''assignment_id'', ''questionnaire_id'', and ''used_in_round''.  It is this table that maintains the knowledge of which rubric is used in which round of an assignment.  If we were to add a new table to maintains the knowledge of which rubric is used in which topic of an assignment as originally suggested, then we would have a big problem.  Knowledge of round-rubric relationship is duplicated.  This would lead (best case scenario) to extra work, and (worst case scenario) to lots of bugs caused by inconsistencies in how these tables are handled with CRUD operations throughout the code.  In other words, this is not a DRY solution.

== Project Implementation ==

In this section, we propose our solution to the problem, discuss implementation techniques and details, and list the goals we achieved.

We start by analyzing Entity Relationship Diagram where we state the solution to the problem. Further we discuss design strategy by breaking project problem into multiple staged sub-problems and provide solutions for each of these sub-problems. We also discuss some implementation details and provide the list of involved files. Finally, we demonstrate how the implemented feature can be used by providing a ''How To'' sub-section.

=== Entity Relationship Diagram ===

Our solution is best introduced by first discussing how the database will be modified.  This modification will be done with a new database migration.

[[File: HW04_ERD.png]]

The sections of the diagram highlighted in yellow show newly introduced items.  That is, we are adding a new column called ''topic_id'' to ''assignment_questionnaires'', in order to link ''assignment_questionnaires'' to ''sign_up_topics''.

Any assignment, topic, or questionnaire may be represented by multiple records within ''assignment_questionnaires'', but each record within ''assignment_questionnaires'' refers to just one assignment, topic, or questionnaire.  It is the ability to have an assignment represented by multiple records, and the new relationship to ''sign_up_topics'', that allows us to support all of the required scenarios:

* Rubric does not vary by round or by topic.
* Rubric varies by round, but not by topic.
* Rubric varies by topic, but not by round.
* Rubric varies by both round and topic.

[[File: HW04_table.PNG]]

This table illustrates the possibilities we now have.

* Assignment 1 does not vary by round or by topic.
* Assignment 2 varies by round, but not by topic.
* Assignment 3 varies by topic, but not by round.
* Assignment 4 varies by both round and topic.

=== Design Strategy ===

As we have concrete understanding of the problem and proposed solution, we would like break this problem into multiple more manageable sub-problems with specific tasks and well-defined solutions to these tasks. Generally, each sub-problem requires modification of one or more files. We would like to propose our Design Strategy as follows:

==== Preparation ====

* Clean up code that our implementation will use
** PROBLEM: We need to add/change content to the edit assignment Topics tab, but unlike other tabs in the views, it does not have its own partial view to work with
*** SOLUTION: Refactor and move the code dealing with topics into separate ''app/views/assignments/edit/_topics.html.erb'' file
*** File: ''app/views/assignments/edit.html.erb''
** PROBLEM: In a section below, we discuss the need to modify existing methods to also accept an optional argument ''topic_id''.  In many cases these existing method use confusing variable names or lack sufficient comments.
*** SOLUTION: Clean up methods that we plan to modify
*** FILE: (many)

==== Implementation ====

* Allow an instructor to indicate that rubric should vary by topic
** PROBLEM: There is no way for an instructor to indicate that an assignments' rubric should vary by topic
*** SOLUTION: Add a new checkbox in the edit assignment Rubric tab to indicate this preference
*** FILE: ''app/views/assignments/edit/_rubrics.html.erb''

* Allow an instructor to choose different rubrics for different topics
** PROBLEM: There is no way for an instructor to choose different rubrics for different topics
*** SOLUTION: Add a new column in the edit assignment Topics tab for choosing rubric(s)
**** New column only visible if rubrics vary by topic, per Rubrics tab
**** New column has multiple rounds per topic only if rubrics vary by round, per Rubrics tab
**** Default value for any rubric is that rubric which is shown on Rubrics tab
**** Rubric(s) in the dropdown list is/are only those that were created by the currently logged in instructor
*** FILE: ''app/views/assignments/edit/_topics.html.erb''
** PROBLEM: The code in ''app/views/assignments/edit/_rubrics.html.erb'' includes dropdowns like the ones we need to add for topics, but that code is way too complex for its functionality (too heavy for a view, uses JavaScript)
*** SOLUTION: Use the code in ''app/views/assignments/edit/_rubrics.html.erb'' for inspiration only
**** Refactor and move as much actual work as possible out into helper methods that are simply called from this view
**** Views are not intended to do heavy lifting
**** Use as little JavaScript as possible, since this is a Ruby On Rails project, not a JS project
*** FILE: ''app/views/assignments/edit/_topics.html.erb''

* Support the ability of the database to link rubrics to topics
** PROBLEM: There is no relationship in the database that can link together rubrics with topics
*** SOLUTION: Add a new migration that adds topic_id field to existing assignment_questionnaires table
**** This new field will reference the id field in the sign_up_topics table
*** FILE: ''db\migrate\[timestamp]_add_topic_id_to_assignment_questionnaires_table.rb''
** PROBLEM: The AssignmentQuestionnaire model does not have any knowledge of topics
*** SOLUTION: Add a new belongs_to reference in the model, to sign_up_topic
*** FILE: ''app\models\assignment_questionnaire.rb''

* React to an instructor saving an assignment after altering the rubrics-vary-by-topic checkbox
** PROBLEM: There is nothing in place to remember when an instructor chooses to vary rubrics by topic, or chooses to not vary rubrics by topic
*** SOLUTION: Upon assignment save, remove all records in the assignment_questionnaires table that relate to this assignment, for which the value of ''topic_id'' no longer makes sense
**** If we now want to vary by topic, we need to remove all records for which ''topic_id'' is nil
**** If we no longer want to vary by topic, we need to remove all records for which ''topic_id'' is not nil
**** Such records are no longer valid, and the instructor will need to specify which rubric to use for which topic
*** FILE: None!
**** Upon assignment save, all records related to this assignment will be removed, and replaced with records that represent the information entered in the ''assignment_form'' displayed in the assignment edit view.  
**** This action is taken by the ''update_assignment_questionnaires'' method in the file ''app\models\assignment_form.rb''.

* Support the ability to find the correct rubric for a particular topic
** PROBLEM: The existing methods allow us to find the correct rubric for a particular round, but not a particular topic
*** SOLUTION: Modify the existing method questionnaire(assignment, type, round_number) to also accept an optional argument ''topic_id''
*** FILE: ''app\helpers\assignment_helper.rb''
*** SOLUTION: Modify the existing method assignment_questionnaire(assignment, type, number) to also accept an optional argument ''topic_id''
*** FILE: ''app\helpers\assignment_helper.rb''
*** SOLUTION: Modify the existing method questionnaire(round = nil) to also accept an optional argument ''topic_id''
*** FILE: ''app\models\review_response_map.rb''
*** SOLUTION: Modify the existing method questionnaire(round) to also accept an optional argument ''topic_id''
*** FILE: ''app\models\self_review_response_map.rb''
*** SOLUTION: Modify the existing method review_questionnaire_id(round = nil) to also accept an optional argument ''topic_id''
*** FILE: ''app\models\assignment.rb''

* Use the correct rubric for a particular topic
** PROBLEM: When finding rubrics to display, save results from, calculate scores from, etc. round may be used but topic is not
*** SOLUTION: Examine all callers of methods modified in the previous section and pass in ''topic_id'' where appropriate to grab the correct rubric
*** FILE: (many)

* Support the ability to determine if an assignment has rubrics that vary by topic
** PROBLEM: There is no handy method to call that can tell us if an assignment has rubrics that vary by topic
*** SOLUTION: Add a new method ''varying_rubrics_by_topic?'' based on the existing method ''varying_rubrics_by_round?''
*** FILE: ''app/models/assignment.rb''

=== (Selected) Modified Code ===

In this section, we provide selected portions of modified code to illustrate how we implemented the new feature.

[to be populated after coding is complete]

=== List of Modified Files ===

In this section, we list all files that were modified while implementing the new feature.

* [to be populated after coding is complete]

== How To ==

In this section, we describe how to use the newly implemented feature.

=== Add a New Rubric ===

* [to be populated after coding is complete]

=== Select a Rubric for a Topic ===

* [to be populated after coding is complete]

== Project Testing ==

=== Strategy ===

To test code implementation, correctness of the added feature, verify that the team did not break any existing functionalities in the Expertiza, and ensure that no bugs were introduced in the code, we developed the following Test Strategy:

# Code inspection
# Run and pass existing RSpec Tests
# Develop New RSpec Tests
# Run through live UI to test a feature using Expertiza instance

=== Rspec Testing ===

==== Existing Tests ====

Run all existing RSpec tests on any changed files, after our changes, to ensure that we have not introduced any failures.
The commands and results are shown below.

<pre>
  [to be populated after coding is complete]
</pre>

==== New Tests ====

Write comprehensive RSpec tests, for all new or modified methods.
* FILE: ''spec\helpers\assignment_helper_spec.rb''
** METHODS TO TEST: 
*** questionnaire(assignment, type, round_number, topic_id)
*** assignment_questionnaire(assignment, type, number, topic_id)
* FILE: ''spec\models\review_response_map_spec.rb''
*** METHODS TO TEST:
**** questionnaire(round, topic_id)
* FILE: ''spec\models\self_review_response_map_spec.rb''
*** METHODS TO TEST:
**** questionnaire(round, topic_id)
* FILE: ''spec\models\assignment_spec.rb''
*** METHODS TO TEST:
**** review_questionnaire_id(round, topic_id)
**** varying_rubrics_by_topic?()

Run these tests, to ensure that the new code works as intended.
The commands and results are shown below.

<pre>
  [to be populated after coding is complete]
</pre>

The test suite for a single new method is below.
* There are many such suites in (TODO add filename(s)).  
* This example illustrates our general strategy:
** test missing input
** test bad input
** test various acceptable forms of input
** test scenarios that lead to "true" and to "false" return values

<pre>
  [to be populated after coding is complete]
</pre>

=== UI Testing ===

Here we describe manual UI Testing that was performed.
[to be populated after coding is complete]

== Conclusion ==

[to be populated after coding is complete]

== Useful Links ==
In this section we provide useful links related to the work that has been completed by our team.
# [https://github.com/gabalmat/expertiza Forked Project Repository]
# [(add link here) Pull Request]
# [(add link here) Video Demonstration of Specialized Rubrics]
# [(add link here) Video Demonstration of Passing Rspec Tests]

== Team ==
=== Contacts ===
We have 4 (four) members in our team and 1 (one) mentor was also assigned to us. For any project-related questions/concerns please contact us:
* Aurora Tiffany-Davis - attiffan@ncsu.edu
* Ginger Balmat - gabalmat@ncsu.edu
* Joe Hutchinson - jehutch3@ncsu.edu
* Nikolay Titov - ngtitov@ncsu.edu
* Zhewei Hu (mentor) - zhu6@ncsu.edu

=== Contribution Based Inquiry ===
For any questions or concerns related to the project design, implementation, testing of the feature developed by our team, please contact an engineer who worked closely on the topic of your interest based on the [https://docs.google.com/spreadsheets/d/11uxuI_5gaC-FQDwIOxtCaN3HZ9bfWDJgIjFemtYV5jE/edit?ts=5ca222f3#gid=0 Contribution Assignment Grid] we created to keep track of our progress and contribution. Please carbon copy all team members and our mentor in the email.

== References ==
* Expertiza Web [https://github.com/expertiza/expertiza#expertiza]
* Expertiza on GitHub [https://github.com/expertiza/expertiza]
* Expertiza Wiki [http://wikis.lib.ncsu.edu/index.php/Expertiza]
* Rspec Documentation [https://relishapp.com/rspec]
* Wiki with Previous Work [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1873_Specialized_rubics_for_different_topic_types]
* Pull Request of the Previous Work [https://github.com/expertiza/expertiza/pull/1327]