Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2023 - E2320. Reimplement the Question Hierarchy

2023-04-27T15:31:27Z

Cbritt:

==Problem Statement==
The current implementation of the question hierarchy is not very clean and contains confusing variable and method names. Also, many methods in the model classes return long HTML strings which are difficult to read. The goal of this project is to reimplement this part of the application to make it more readable, understandable and maintainable. This includes cleaning up the existing classes

===Explanation of Feature===
The Question class and its sub-classes are used to implement all rubric items, quiz questions, and survey questions in Expertiza. For example, a professor could use this feature to make up a questionnaire for their class. There are 3 main types of questions in Experitza: scored, unscored, and upload file.

Below is a written explanation of the hierarchy. For a visual reference, refer to the [[#UML Diagram]]:

'''1. Choice question''' are types of questions that give the user a list of answers to choose from. It is broken into two subcategories: scored and unscored.
* '''Scored questions''' are questions that are assigned a point value and contribute to the final score of the questionnaire.
** Scale - a set of answer options that typically cover a range of opinions, e.g. Agree, Neither agree nor disagree, Disagree, etc.
** Criterion - a standard for judging something,
* '''Unscored questions''' are questions that do not contribute to the final score of the questionnaire.
** Dropdown - list of options displayed in a dropdown menu.
** Multiple Choice - presents multiple options from a list of possible answers and can be single select (radio buttons) or multi-select (check boxes).
** Check Box - allows multiple selections from a list of options.

'''2. Text Response''' allows the user to type in their answer instead of choosing from a list of answer options.
* Text Area - text box which has a height and width associated with it that can be adjusted.
* Text Field - 1 input line that does not change shape.

'''3. Upload File'''
The upload file option allows the user to upload a file with valid input to use as a questionnaire (as the name suggests). The user can also export the questionnaire to a .csv file.

===Goals===
Our goals for reimplementation and to improve the code:
* Improve variables and methods names to give accurate representation of their functionality.
* Include comments for further clarification.
* Implement partials to deal with the HTML strings - this will DRY up the code.
* Add RSpec test cases - ensure existing tests work and add more where applicable.

===Design Goals===
'''1. Update code comments'''

Some methods and classes had little to no comments before this project, and any existing comments were not in depth enough to give proper context for functionality. One of our design goals is to write more in depth comments that better explain functionality for the code.

'''2. DRY out code with partials'''

Another one of our design goals is to implement additional partials for the question types. For program 3 we started adding partials by looking at the similarities between all three question types and pulling out the similarities into partials which we stored in [https://github.com/pparghod/reimplementation-back-end/tree/main/app/views 'app/views']. Then we made calls to these partials from within each subclass. An example of a partial we created can be seen [https://github.com/pparghod/reimplementation-back-end/blob/main/app/views/questionnaire/edit/_edit_dropdown.erb here], where we made a partial for code that displays an edit input for dropdown questions. Thanks to this partial, in the future if we ever need to call this code again we can just [https://github.com/pparghod/reimplementation-back-end/blob/20093dcb23750c94a9c32803914e1506c9ae556e/app/models/dropdown.rb#L7 call the partial], reducing the number of lines of code and reducing redundancy.

'''3. Controllers'''

The controllers to be implemented are questionnaires_controller.rb and questions_controller.rb. In the previous implementation of questionnaires_controller.rb, it contained several functions which will be moved to questions_controller.rb because they specifically pertain to questions and not the questionnaire. The questions controller will store all of the partials we have made so far and any additional partials we need to create. This will keep all the partials in one central location and DRY out the code to follow better design.

See [[#Model-Controller Diagram]] for the model and controller design.

The following functions have been moved from questionnaires_controller.rb to questions_controller.rb:
add_new_questions()
save_all_questions()
save_new_questions()
delete_questions()
save_questions()

=== UML Diagram ===

====Question Hierarchy====
Below is a diagram showing the overall Question hierarchy to better give an idea of it's structure. (Click on the image to zoom in.)

[[File:E2320-UML.png|1200px]]

====Model-Controller Diagram====
Below is a model dependency diagram including the controllers. (Click on the image to zoom in.)

[[File:E2320-model-controller-dependency-diagram.png|1100px]]

== Test Plan ==

===RSpec===

We reimplemented the test cases to match the changes we've made to the question-related models. One of the primary goals we had were to make sure that the existing tests still passed. Several tests were removed for the edit methods in a few of the models (such as checkbox_spec.rb and dropdown_spec.rb) because those methods were replaced with partials. Partials have not been fully implemented which is why we did not include tests for them. However, this is something that should be revisited in the future.

Several components we tested for are:
* Test that the question was completed
* Test that the question input is valid
* Test that the question text can be viewed
* Test if the correct question text is viewed by an instructor or a student
* Test if the instructor added in a column header, section header or table header and that it was completed
* Test that the alternatives were completed

Given below is an example of the tests we've written:
describe Dropdown do
let!(:dropdown) { Dropdown.create(id: 4, type: 'Dropdown', seq: 4.0, txt: 'Test text', weight: 13) }
let!(:answer) { Answer.create(id: 1, question_id: 4, questionnaire_type_id: 1, answer: 1, comments: "Test comment") }
describe '#view_question_text' do
it 'returns the html' do
html = dropdown.view_question_text
expect(html).to eq('<TR><TD align="left"> Test text </TD><TD align="left">Dropdown</TD><td align="center">13</TD><TD align="center">—</TD></TR>')
end
end
describe '#view_completed_question' do
it 'returns the html' do
html = dropdown.view_completed_question(1, answer)
expect(html).to eq('<nowiki><b></nowiki>1. Test text<nowiki></b><BR></nowiki>&nbsp&nbsp&nbsp&nbspTest comment')
end
end
describe '#complete_for_alternatives' do
it 'returns the html' do
alternatives = ['Alternative 1', 'Alternative 2', 'Alternative 3']
html = dropdown.complete_for_alternatives(alternatives, answer)
expect(html).to eq('<option value="Alternative 1">Alternative 1</option><option value="Alternative 2">Alternative 2</option><option value="Alternative 3">Alternative 3</option>')
end
end
describe '#complete' do
it 'returns the html' do
alternatives = ['Alternative 1|Alternative 2|Alternative 3']
allow(dropdown).to receive(:alternatives).and_return(alternatives)
allow(dropdown).to receive(:complete_for_alternatives).and_return('')
html = dropdown.complete(1, answer)
<nowiki>expect(html).to eq('<p style="width: 80%;"><label for="responses_1"">Test text  </label>'
+ '<input id="responses_1_score" name="responses[1][score]" type="hidden" value="" style="min-width: 100px;">'
+ '<select id="responses_1_comments" label=Test text name="responses[1][comment]"></select></p>')</nowiki>
end
end
end

Given below is the full list of tests:

[[File:E2320-RSpec.png]]

==Conclusions==
===Tasks Completed===
The table below highlights the work we have completed so far:

{| class="wikitable" style="width: 100%;
!  #  !! File !! Changes Made !! Test
|-
|1
|questionnaires_controller.rb
|
*Moved several functions to questions_controllers.rb
*Updated comments for further clarification
|
TBA
|-
|2
|questions_controller.rb
|
*Implemented functions from questionnaires_controller.rb
*Updated comments for further clarification
|
TBA
|-
|3
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/checkbox.rb checkbox.rb]
|
*Replaced 'edit' method with partial
*Added comments - Provided functionality detail in the comments for all methods
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/checkbox_spec.rb Created RSpec testing for all method]
|-
|4
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/criterion.rb criterion.rb]
|
*Replaced 'edit' method with partial
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/criterion_spec.rb Created RSpec testing for all method, and different question scenarios]
|-
|5
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/dropdown.rb dropdown.rb]
|
*Replaced 'edit' method with partial
*Added comments - none existed previously
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/dropdown_spec.rb RSpec test - tests 4 methods]
|-
|6
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/multiple_choice_checkbox.rb multiple_choice_checkbox.rb]
|
*Replaced 'edit' method with partial
*Updated comments - more details in how all functions work
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/multiple_choice_checkbox_spec.rb RSpec test - all methods and different # of boxes selected]
|-
|7
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/multiple_choice_radio.rb multiple_choice_radio.rb]
|
*Replaced 'edit' method with partial
*Updated comments - more details in how all functions work
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/multiple_choice_radio_spec.rb RSpec test - different tests to make sure valid questions can be created]
|-
|8
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/scale.rb scale.rb]
|
*Replaced 'edit' method with partial
*Updated comments - more details in how all functions work
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/scale_spec.rb RSpec test - tests all methods]
|-
|9
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/text_area.rb text_area.rb]
|
*Added partial to 'complete' method
*Added comments - none existed previously
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/text_area_spec.rb RSpec test - tests all methods]
|-
|10
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/text_field.rb text_field.rb]
|
*Added partial to 'complete' method
*Added comments - none existed previously
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/text_field_spec.rb RSpec test - tests all methods]
|-
|11
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/upload_file.rb upload_file.rb]
|
*Added comments - none existed previously
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/upload_file.rb RSpec test - tests 2 methods]
|}

Given below is an example of the comments we've added to clarify what the methods are doing, because the method name alone can be confusing. In the example below, the name 'complete_first_second_input' might not be intuitive for someone unfamiliar with the code. The added comments provide more insight into what will be displayed for each method.

From [https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/checkbox.rb checkbox.rb]:

'''# Returns what to display for the first and second inputs (comments and scores).'''
def complete_first_second_input(count, answer = nil)
...
end

'''# Returns what to display for the third input (the checkbox itself).'''
def complete_third_input(count, answer = nil)
...
end

'''# Create the executable script for client-side interaction on the checkbox'''
def complete_script(count)
...
end

Overall, we met our goals of adding comments and improving the names of methods and variables to make the code easily understandable to the user. We implemented several partials to handle the HTML strings and added RSpec test cases. We cleaned up the unused comments/code to make the code readable and understandable.

===Next Steps===
In the future, we would like to fully implement partials and thoroughly test them. We believe partials will improve the code by making it more readable and reusable. Then we would like to get our code ready to merge into Expertiza.

==Team==
=====Mentor=====
* Prof. Edward F. Gehringer
* Priyam Garg

=====Members=====
* Colleen Britt
* Kimberly Jones
* Priyanka Arghode
==References==

#[https://expertiza.ncsu.edu/ Expertiza]
#[https://stackoverflow.com/questions/3425971/organizing-partials-for-a-polymorphic-resource Organizing Partials]
#[https://www.amberbit.com/blog/2011/12/27/render-views-and-partials-outside-controllers-in-rails-3 Render Views and Partials Outside Controllers]
#[https://github.com/pparghod/reimplementation-back-end Github Repo]
#[https://github.com/expertiza/reimplementation-back-end/pull/10 Link to initial pull request]
#[https://github.com/users/pparghod/projects/2/views/1 GitHub Project Board]

CSC/ECE 517 Spring 2023 - E2320. Reimplement the Question Hierarchy

2023-04-13T02:06:57Z

Cbritt:

Design Doc

==Problem Statement==
The current implementation of the question hierarchy is not very clean and contains confusing variable and method names. Also, many methods in the model classes return long HTML strings which are difficult to read. The goal of this project is to reimplement this part of the application to make it more readable, understandable and maintainable. This includes cleaning up the existing classes

===Explanation of Feature===
The Question class and its sub-classes are used to implement all rubric items, quiz questions, and survey questions in Expertiza. For example, a professor could use this feature to make up a questionnaire for their class. There are 3 main types of questions in Experitza: scored, unscored, and upload file.

Below is a written explanation of the hierarchy. For a visual reference, refer to the [[#UML Diagram]]:

'''1. Choice question''' are types of questions that give the user a list of answers to choose from. It is broken into two subcategories: scored and unscored.
* '''Scored questions''' are questions that are assigned a point value and contribute to the final score of the questionnaire.
** Scale - a set of answer options that typically cover a range of opinions, e.g. Agree, Neither agree nor disagree, Disagree, etc.
** Criterion - a standard for judging something,
* '''Unscored questions''' are questions that do not contribute to the final score of the questionnaire.
** Dropdown - list of options displayed in a dropdown menu.
** Multiple Choice - presents multiple options from a list of possible answers and can be single select (radio buttons) or multi-select (check boxes).
** Check Box - allows multiple selections from a list of options.

'''2. Text Response''' allows the user to type in their answer instead of choosing from a list of answer options.
* Text Area - text box which has a height and width associated with it that can be adjusted.
* Text Field - 1 input line that does not change shape.

'''3. Upload File'''
The upload file option allows the user to upload a file with valid input to use as a questionnaire (as the name suggests). The user can also export the questionnaire to a .csv file.

===Goals===
Our goals for reimplementation and to improve the code:
* Improve variables and methods names to give accurate representation of their functionality.
* Include comments for further clarification.
* Implement partials to deal with the HTML strings - this will DRY up the code.
* Add RSpec test cases - ensure existing tests work and add more where applicable.

===Design Goals===
'''1. Update code comments'''

Some methods and classes had little to no comments before this project, and any existing comments were not in depth enough to give proper context for functionality. One of our design goals is to write more in depth comments that better explain functionality for the code.

'''2. DRY out code with partials'''

Another one of our design goals is to implement additional partials for the question types. For program 3 we started adding partials by looking at the similarities between all three question types and pulling out the similarities into partials which we stored in [https://github.com/pparghod/reimplementation-back-end/tree/main/app/views 'app/views']. Then we made calls to these partials from within each subclass. An example of a partial we created can be seen [https://github.com/pparghod/reimplementation-back-end/blob/main/app/views/questionnaire/edit/_edit_dropdown.erb here], where we made a partial for code that displays an edit input for dropdown questions. Thanks to this partial, in the future if we ever need to call this code again we can just [https://github.com/pparghod/reimplementation-back-end/blob/20093dcb23750c94a9c32803914e1506c9ae556e/app/models/dropdown.rb#L7 call the partial], reducing the number of lines of code and reducing redundancy.

'''3. Controllers'''

The controllers to be implemented are questionnaires_controller.rb and questions_controller.rb. In the previous implementation of questionnaires_controller.rb, it contained several functions which will be moved to questions_controller.rb because they specifically pertain to questions and not the questionnaire. The questions controller will store all of the partials we have made so far and any additional partials we need to create. This will keep all the partials in one central location and DRY out the code to follow better design.

See [[#Model-Controller Diagram]] for the model and controller design.

The following functions have been moved from questionnaires_controller.rb to questions_controller.rb:
add_new_questions()
save_all_questions()
save_new_questions()
delete_questions()
save_questions()

=== UML Diagram ===

====Question Hierarchy====
Below is a diagram showing the overall Question hierarchy to better give an idea of it's structure. (Click on the image to zoom in.)

[[File:E2320-UML.png|1200px]]

====Model-Controller Diagram====
Below is a model dependency diagram including the controllers. (Click on the image to zoom in.)

[[File:E2320-model-controller-dependency-diagram.png|1100px]]

== Test Plan ==

===RSpec===

We reimplemented the test cases to match the changes we've made to the question-related models. One of the primary goals we had were to make sure that the existing tests still passed. Several tests were removed for the edit methods in a few of the models (such as checkbox_spec.rb and dropdown_spec.rb) because those methods were replaced with partials. Partials have not been fully implemented which is why we did not include tests for them. However, this is something that should be revisited in the future.

Several components we tested for are:
* Test that the question was completed
* Test that the question input is valid
* Test that the question text can be viewed
* Test if the correct question text is viewed by an instructor or a student
* Test if the instructor added in a column header, section header or table header and that it was completed
* Test that the alternatives were completed

Given below is an example of the tests we've written:
describe Dropdown do
let!(:dropdown) { Dropdown.create(id: 4, type: 'Dropdown', seq: 4.0, txt: 'Test text', weight: 13) }
let!(:answer) { Answer.create(id: 1, question_id: 4, questionnaire_type_id: 1, answer: 1, comments: "Test comment") }
describe '#view_question_text' do
it 'returns the html' do
html = dropdown.view_question_text
expect(html).to eq('<TR><TD align="left"> Test text </TD><TD align="left">Dropdown</TD><td align="center">13</TD><TD align="center">—</TD></TR>')
end
end
describe '#view_completed_question' do
it 'returns the html' do
html = dropdown.view_completed_question(1, answer)
expect(html).to eq('<nowiki><b></nowiki>1. Test text<nowiki></b><BR></nowiki>&nbsp&nbsp&nbsp&nbspTest comment')
end
end
describe '#complete_for_alternatives' do
it 'returns the html' do
alternatives = ['Alternative 1', 'Alternative 2', 'Alternative 3']
html = dropdown.complete_for_alternatives(alternatives, answer)
expect(html).to eq('<option value="Alternative 1">Alternative 1</option><option value="Alternative 2">Alternative 2</option><option value="Alternative 3">Alternative 3</option>')
end
end
describe '#complete' do
it 'returns the html' do
alternatives = ['Alternative 1|Alternative 2|Alternative 3']
allow(dropdown).to receive(:alternatives).and_return(alternatives)
allow(dropdown).to receive(:complete_for_alternatives).and_return('')
html = dropdown.complete(1, answer)
<nowiki>expect(html).to eq('<p style="width: 80%;"><label for="responses_1"">Test text  </label>'
+ '<input id="responses_1_score" name="responses[1][score]" type="hidden" value="" style="min-width: 100px;">'
+ '<select id="responses_1_comments" label=Test text name="responses[1][comment]"></select></p>')</nowiki>
end
end
end

Given below is the full list of tests:

[[File:E2320-RSpec.png]]

==Conclusions==
===Tasks Completed===
The table below highlights the work we have completed so far:

{| class="wikitable" style="width: 100%;
!  #  !! File !! Changes Made !! Test
|-
|1
|questionnaires_controller.rb
|
*Moved several functions to questions_controllers.rb
*Updated comments for further clarification
|
TBA
|-
|2
|questions_controller.rb
|
*Implemented functions from questionnaires_controller.rb
*Updated comments for further clarification
|
TBA
|-
|3
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/checkbox.rb checkbox.rb]
|
*Replaced 'edit' method with partial
*Added comments - Provided functionality detail in the comments for all methods
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/checkbox_spec.rb Created RSpec testing for all method]
|-
|4
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/criterion.rb criterion.rb]
|
*Replaced 'edit' method with partial
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/criterion_spec.rb Created RSpec testing for all method, and different question scenarios]
|-
|5
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/dropdown.rb dropdown.rb]
|
*Replaced 'edit' method with partial
*Added comments - none existed previously
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/dropdown_spec.rb RSpec test - tests 4 methods]
|-
|6
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/multiple_choice_checkbox.rb multiple_choice_checkbox.rb]
|
*Replaced 'edit' method with partial
*Updated comments - more details in how all functions work
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/multiple_choice_checkbox_spec.rb RSpec test - all methods and different # of boxes selected]
|-
|7
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/multiple_choice_radio.rb multiple_choice_radio.rb]
|
*Replaced 'edit' method with partial
*Updated comments - more details in how all functions work
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/multiple_choice_radio_spec.rb RSpec test - different tests to make sure valid questions can be created]
|-
|8
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/scale.rb scale.rb]
|
*Replaced 'edit' method with partial
*Updated comments - more details in how all functions work
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/scale_spec.rb RSpec test - tests all methods]
|-
|9
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/text_area.rb text_area.rb]
|
*Added partial to 'complete' method
*Added comments - none existed previously
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/text_area_spec.rb RSpec test - tests all methods]
|-
|10
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/text_field.rb text_field.rb]
|
*Added partial to 'complete' method
*Added comments - none existed previously
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/text_field_spec.rb RSpec test - tests all methods]
|-
|11
|[https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/upload_file.rb upload_file.rb]
|
*Added comments - none existed previously
|[https://github.com/pparghod/reimplementation-back-end/blob/main/spec/models/upload_file.rb RSpec test - tests 2 methods]
|}

Given below is an example of the comments we've added to clarify what the methods are doing, because the method name alone can be confusing. In the example below, the name 'complete_first_second_input' might not be intuitive for someone unfamiliar with the code. The added comments provide more insight into what will be displayed for each method.

From [https://github.com/pparghod/reimplementation-back-end/blob/main/app/models/checkbox.rb checkbox.rb]:

'''# Returns what to display for the first and second inputs (comments and scores).'''
def complete_first_second_input(count, answer = nil)
...
end

'''# Returns what to display for the third input (the checkbox itself).'''
def complete_third_input(count, answer = nil)
...
end

'''# Create the executable script for client-side interaction on the checkbox'''
def complete_script(count)
...
end

Overall, we met our goals of adding comments and improving the names of methods and variables to make the code easily understandable to the user. We implemented several partials to handle the HTML strings and added RSpec test cases. We cleaned up the unused comments/code to make the code readable and understandable.

===Next Steps===
In the future, we would like to fully implement partials and thoroughly test them. We believe partials will improve the code by making it more readable and reusable. Then we would like to get our code ready to merge into Expertiza.

==Team==
=====Mentor=====
* Prof. Edward F. Gehringer
* Priyam Garg

=====Members=====
* Colleen Britt
* Kimberly Jones
* Priyanka Arghode
==References==

#[https://expertiza.ncsu.edu/ Expertiza]
#[https://stackoverflow.com/questions/3425971/organizing-partials-for-a-polymorphic-resource Organizing Partials]
#[https://www.amberbit.com/blog/2011/12/27/render-views-and-partials-outside-controllers-in-rails-3 Render Views and Partials Outside Controllers]
#[https://github.com/pparghod/reimplementation-back-end Github Repo]
#[https://github.com/expertiza/reimplementation-back-end/pull/10 Link to initial pull request]
#[https://github.com/users/pparghod/projects/2/views/1 GitHub Project Board]

File:E2320-model-controller-dependency-diagram.png

2023-04-13T01:18:30Z

Cbritt:

CSC/ECE 517 Spring 2023 - E2320. Reimplement the Question Hierarchy

2023-04-08T01:08:40Z

Cbritt:

Design Doc

==Problem Statement==
The current implementation of the question hierarchy is not very clean and contains confusing variable and method names. Also, many methods return long HTML strings which are difficult to read. The goal of this project is to reimplement this part of the application to make it more readable, understandable and maintainable.

===Explanation of Feature - Question Hierarchy===
The Question class and its sub-classes are used to implement all rubric items, quiz questions, and survey questions in Expertiza. For example, a professor could use this feature to make up a review quiz for their class. There are 3 main types of questions in Experitza: scored, unscored, and upload file.

Here is the hierarchy:

'''1. Choice question'''
* Scored question
** Scale
** Criterion
* Unscored question
** Dropdown
** Multiple Choice
** Check Box
'''2. Text Response'''
* Text Area
* Text Field
'''3. Upload File'''

Choice questions are types of questions that give the quiz taker a list of answers to choose from. It is broken into two subcategories scored and unscored. Scored question will give a number value depending upon if a user clicks on a particular answer. The unscored questions don't have a score associated with them and come in a few different styles. The answers could be presented in a dropdown menu which only shows the answer choices after the user clicks on the dropdown arrow and clicks on an answer. Multiple choice questions present all the answers choices with a selectable bubble beside them and allow the user to click on the bubble to indicate their answer. Checkboxes are similar to multiple choice in that they present all of the answer choices at once however, the user must click on a certain number of boxes beside the answers they think are correct.

Text response questions are different in that they allow the user to actually type in their answer instead of just being provided answers. A text area question has a height and width associated with it that can be adjusted while a text field question is just 1 input line that does not change shape.

The last type of question is upload file which allows the user to upload a file to use as a quiz (as the name suggests). This option allows a person to upload a pre-made quiz document to be which will be converted into a quiz. So, a professor could type up their quiz questions and answers in a text file then choose upload and have Expertiza convert it into a quiz for them.

===Goals===
* Improved naming of variables and methods
* Included comments for further clarification
* Implemented partials to deal with the HTML strings
* Added RSpec test cases

==Plan of work==

Based on the feedback provided to us by both our mentors and also peer reviews our team has decided upon a few key design goals to work on for the continuation of our work into Program 4. These goals are outlined below.

===Design Goals===
'''1. Update code comments'''

Some methods and classes had little to no comments, and existing comments were not in depth enough to give proper context for functionality. One of our design goals is to write more in depth comments that better explain functionality for the code.

The files listed below have been updated with new comments:
*questionnaires_controller.rb
*checkbox.rb
*criterion.rb
*dropdown.rb
*multiple_choice_checkbox.rb
*multiple_choice_radio.rb
*scale.rb
*text_area.rb
*text_field.rb
*text_response.rb
*upload_file.rb

Given below is an example of the comments we've added to clarify what the methods are doing because the method name alone can be confusing.
From checkbox.rb:

'''# Returns what to display for the first and second inputs (comments and scores).'''
def complete_first_second_input(count, answer = nil)
html = "<input id=\"responses_#{count.to_s}_comments\" name=\"responses[#{count.to_s}][comment]\" type=\"hidden\" value=\"\">"
html += "<input id=\"responses_#{count.to_s}_score\" name=\"responses[#{count.to_s}][score]\" type=\"hidden\""
html += if !answer.nil? && (answer.answer == 1)
'value="1"'
else
'value="0"'
end
html += '>'
html
end

'''# Returns what to display for the third input (the checkbox itself).'''
def complete_third_input(count, answer = nil)
html = "<input id=\"responses_#{count.to_s}_checkbox\" type=\"checkbox\" onchange=\"checkbox#{count.to_s}Changed()\""
html += 'checked="checked"' if !answer.nil? && (answer.answer == 1)
html += '>'
html
end

'''# Create the executable script for client-side interaction on the checkbox'''
def complete_script(count)
html = "<script>function checkbox#{count.to_s}Changed() {"
html += " var checkbox = jQuery(\"#responses_#{count.to_s}_checkbox\");"
html += " var response_score = jQuery(\"#responses_#{count.to_s}_score\");"
html += 'if (checkbox.is(":checked")) {'
html += 'response_score.val("1");'
html += '} else {'
html += 'response_score.val("0");}}</script>'
html
end

'''2. DRY out code with partials'''

Another one of our design goals is to implement additional partials for the question types. We added partials by looking at the similarities between all three question types and pull out the similarities into a new class.
*Ex: Question_Controller - Since all of the sub-categories inherit from the Question class we plan to make a question controller to hold all of the common functionality. One example of this can be seen with the method call 'edit' which exists in many of the subclasses like text_response.rb, text_area.rb, scale.rb, and criterion.rb. The partials will be moved into the question controller.

== Tests ==

'''RSpec'''

We reimplemented the test cases to match the changes we've made to the question-related models. Front-end testing wasn't necessary because our project doesn't involve changing any controller.

The most notable models that were tested are:
checkbox.rb
criterion.rb
dropdown.rb
multiple_choice_checkbox.rb
multiple_choice_radio.rb
scale.rb
text_area.rb
text_field.rb
text_response.rb
upload_file.rb

One of the primary goals we had were to make sure that the existing tests still passed. Several tests were removed for the edit methods in a few of the models (such as checkbox_spec.rb and dropdown_spec.rb) because those methods were replaced with partials. Partials have not been fully implemented which is why we did not include tests for them. However, this is something that should be revisited in the future.

Given below is an example of the tests we've written:
describe Dropdown do
let!(:dropdown) { Dropdown.create(id: 4, type: 'Dropdown', seq: 4.0, txt: 'Test text', weight: 13) }
let!(:answer) { Answer.create(id: 1, question_id: 4, questionnaire_type_id: 1, answer: 1, comments: "Test comment") }
describe '#view_question_text' do
it 'returns the html' do
html = dropdown.view_question_text
expect(html).to eq('<TR><TD align="left"> Test text </TD><TD align="left">Dropdown</TD><td align="center">13</TD><TD align="center">—</TD></TR>')
end
end
describe '#view_completed_question' do
it 'returns the html' do
html = dropdown.view_completed_question(1, answer)
expect(html).to eq('<nowiki><b></nowiki>1. Test text<nowiki></b><BR></nowiki>&nbsp&nbsp&nbsp&nbspTest comment')
end
end
describe '#complete_for_alternatives' do
it 'returns the html' do
alternatives = ['Alternative 1', 'Alternative 2', 'Alternative 3']
html = dropdown.complete_for_alternatives(alternatives, answer)
expect(html).to eq('<option value="Alternative 1">Alternative 1</option><option value="Alternative 2">Alternative 2</option><option value="Alternative 3">Alternative 3</option>')
end
end
describe '#complete' do
it 'returns the html' do
alternatives = ['Alternative 1|Alternative 2|Alternative 3']
allow(dropdown).to receive(:alternatives).and_return(alternatives)
allow(dropdown).to receive(:complete_for_alternatives).and_return('')
html = dropdown.complete(1, answer)
<nowiki>expect(html).to eq('<p style="width: 80%;"><label for="responses_1"">Test text  </label>'
+ '<input id="responses_1_score" name="responses[1][score]" type="hidden" value="" style="min-width: 100px;">'
+ '<select id="responses_1_comments" label=Test text name="responses[1][comment]"></select></p>')</nowiki>
end
end
end

Given below is the full list of tests:

[[File:E2320-RSpec.png]]

==Conclusions==
===Tasks Completed===
We met our goals of adding comments and improving the names of methods and variables to make the code easily understandable to the user. We implemented several partials to handle the HTML strings and added RSpec test cases.
===Next Steps===
In the future, we would like to fully implement partials and thoroughly test them. We believe partials will improve the code by making it more readable and reusable.

==Team==
=====Mentor=====
* Prof. Edward F. Gehringer
* Priyam Garg

=====Members=====
* Colleen Britt
* Kimberly Jones
* Priyanka Arghode
==References==

#[https://expertiza.ncsu.edu/ Expertiza]
#[https://stackoverflow.com/questions/3425971/organizing-partials-for-a-polymorphic-resource Organizing Partials]
#[https://www.amberbit.com/blog/2011/12/27/render-views-and-partials-outside-controllers-in-rails-3 Render Views and Partials Outside Controllers]
#[https://github.com/pparghod/reimplementation-back-end Github Repo]
#[https://github.com/expertiza/reimplementation-back-end/pull/10 Link to initial pull request]
#[https://github.com/users/pparghod/projects/2/views/1 GitHub Project Board]

CSC/ECE 517 Spring 2023 - E2320. Reimplement the Question Hierarchy

2023-04-08T00:59:56Z

Cbritt:

Design Doc

==Problem Statement==
The current implementation of the question hierarchy is not very clean and contains confusing variable and method names. Also, many methods return long HTML strings which are difficult to read. The goal of this project is to reimplement this part of the application to make it more readable, understandable and maintainable.

===Explanation of Feature - Question Hierarchy===
The Question class and its sub-classes are used to implement all rubric items, quiz questions, and survey questions in Expertiza. For example, a professor could use this feature to make up a review quiz for their class. There are 3 main types of questions in Experitza: scored, unscored, and upload file.

Here is the hierarchy:

'''1. Choice question'''
* Scored question
** Scale
** Criterion
* Unscored question
** Dropdown
** Multiple Choice
** Check Box
'''2. Text Response'''
* Text Area
* Text Field
'''3. Upload File'''

Choice questions are types of questions that give the quiz taker a list of answers to choose from. It is broken into two subcategories scored and unscored. Scored question will give a number value depending upon if a user clicks on a particular answer. The unscored questions don't have a score associated with them and come in a few different styles. The answers could be presented in a dropdown menu which only shows the answer choices after the user clicks on the dropdown arrow and clicks on an answer. Multiple choice questions present all the answers choices with a selectable bubble beside them and allow the user to click on the bubble to indicate their answer. Checkboxes are similar to multiple choice in that they present all of the answer choices at once however, the user must click on a certain number of boxes beside the answers they think are correct.

Text response questions are different in that they allow the user to actually type in their answer instead of just being provided answers. A text area question has a height and width associated with it that can be adjusted while a text field question is just 1 input line that does not change shape.

The last type of question is upload file which allows the user to upload a file to use as a quiz (as the name suggests). This option allows a person to upload a pre-made quiz document to be which will be converted into a quiz. So, a professor could type up their quiz questions and answers in a text file then choose upload and have Expertiza convert it into a quiz for them.

===List of Work Done so Far===
The following list describes tasks that were accomplished:
* Improved naming of variables and methods
* Included comments for further clarification
* Implemented partials to deal with the HTML strings
* Added RSpec test cases

==Plan of work==

Based on the feedback provided to us by both our mentors and also peer reviews our team has decided upon a few key design goals to work on for the continuation of our work into Program 4. These goals are outlined below.

===Design Goals===
'''1. Update code comments'''

Some methods and classes had little to no comments, and existing comments were not in depth enough to give proper context for functionality. One of our design goals is to write more in depth comments that better explain functionality for the code.

The files listed below have been updated with new comments:
*questionnaires_controller.rb
*checkbox.rb
*criterion.rb
*dropdown.rb
*multiple_choice_checkbox.rb
*multiple_choice_radio.rb
*scale.rb
*text_area.rb
*text_field.rb
*text_response.rb
*upload_file.rb

Given below is an example of the comments we've added to clarify what the methods are doing because the method name alone can be confusing.
From checkbox.rb:

'''# Returns what to display for the first and second inputs (comments and scores).'''
def complete_first_second_input(count, answer = nil)
html = "<input id=\"responses_#{count.to_s}_comments\" name=\"responses[#{count.to_s}][comment]\" type=\"hidden\" value=\"\">"
html += "<input id=\"responses_#{count.to_s}_score\" name=\"responses[#{count.to_s}][score]\" type=\"hidden\""
html += if !answer.nil? && (answer.answer == 1)
'value="1"'
else
'value="0"'
end
html += '>'
html
end

'''# Returns what to display for the third input (the checkbox itself).'''
def complete_third_input(count, answer = nil)
html = "<input id=\"responses_#{count.to_s}_checkbox\" type=\"checkbox\" onchange=\"checkbox#{count.to_s}Changed()\""
html += 'checked="checked"' if !answer.nil? && (answer.answer == 1)
html += '>'
html
end

'''# Create the executable script for client-side interaction on the checkbox'''
def complete_script(count)
html = "<script>function checkbox#{count.to_s}Changed() {"
html += " var checkbox = jQuery(\"#responses_#{count.to_s}_checkbox\");"
html += " var response_score = jQuery(\"#responses_#{count.to_s}_score\");"
html += 'if (checkbox.is(":checked")) {'
html += 'response_score.val("1");'
html += '} else {'
html += 'response_score.val("0");}}</script>'
html
end

'''2. DRY out code with partials'''

Another one of our design goals is to implement additional partials for the question types. We added partials by looking at the similarities between all three question types and pull out the similarities into a new class.
*Ex: Question_Controller - Since all of the sub-categories inherit from the Question class we plan to make a question controller to hold all of the common functionality. One example of this can be seen with the method call 'edit' which exists in many of the subclasses like text_response.rb, text_area.rb, scale.rb, and criterion.rb. The partials will be moved into the question controller.

== Tests ==

'''RSpec'''

We reimplemented the test cases to match the changes we've made to the question-related models. Front-end testing wasn't necessary because our project doesn't involve changing any controller.

The most notable models that were tested are:
checkbox.rb
criterion.rb
dropdown.rb
multiple_choice_checkbox.rb
multiple_choice_radio.rb
scale.rb
text_area.rb
text_field.rb
text_response.rb
upload_file.rb

One of the primary goals we had were to make sure that the existing tests still passed. Several tests were removed for the edit methods in a few of the models (such as checkbox_spec.rb and dropdown_spec.rb) because those methods were replaced with partials. Partials have not been fully implemented which is why we did not include tests for them. However, this is something that should be revisited in the future.

Given below is an example of the tests we've written:
describe Dropdown do
let!(:dropdown) { Dropdown.create(id: 4, type: 'Dropdown', seq: 4.0, txt: 'Test text', weight: 13) }
let!(:answer) { Answer.create(id: 1, question_id: 4, questionnaire_type_id: 1, answer: 1, comments: "Test comment") }
describe '#view_question_text' do
it 'returns the html' do
html = dropdown.view_question_text
expect(html).to eq('<TR><TD align="left"> Test text </TD><TD align="left">Dropdown</TD><td align="center">13</TD><TD align="center">—</TD></TR>')
end
end
describe '#view_completed_question' do
it 'returns the html' do
html = dropdown.view_completed_question(1, answer)
expect(html).to eq('<nowiki><b></nowiki>1. Test text<nowiki></b><BR></nowiki>&nbsp&nbsp&nbsp&nbspTest comment')
end
end
describe '#complete_for_alternatives' do
it 'returns the html' do
alternatives = ['Alternative 1', 'Alternative 2', 'Alternative 3']
html = dropdown.complete_for_alternatives(alternatives, answer)
expect(html).to eq('<option value="Alternative 1">Alternative 1</option><option value="Alternative 2">Alternative 2</option><option value="Alternative 3">Alternative 3</option>')
end
end
describe '#complete' do
it 'returns the html' do
alternatives = ['Alternative 1|Alternative 2|Alternative 3']
allow(dropdown).to receive(:alternatives).and_return(alternatives)
allow(dropdown).to receive(:complete_for_alternatives).and_return('')
html = dropdown.complete(1, answer)
<nowiki>expect(html).to eq('<p style="width: 80%;"><label for="responses_1"">Test text  </label>'
+ '<input id="responses_1_score" name="responses[1][score]" type="hidden" value="" style="min-width: 100px;">'
+ '<select id="responses_1_comments" label=Test text name="responses[1][comment]"></select></p>')</nowiki>
end
end
end

Given below is the full list of tests:

[[File:E2320-RSpec.png]]

==Conclusions / Future Work==
===Specific Tasks Completed===
[Will be updated near final submission deadline]

==Team==
=====Mentor=====
* Prof. Edward F. Gehringer
* Priyam Garg

=====Members=====
* Colleen Britt
* Kimberly Jones
* Priyanka Arghode
==References==

#[https://expertiza.ncsu.edu/ Expertiza]
#[https://stackoverflow.com/questions/3425971/organizing-partials-for-a-polymorphic-resource Organizing Partials]
#[https://www.amberbit.com/blog/2011/12/27/render-views-and-partials-outside-controllers-in-rails-3 Render Views and Partials Outside Controllers]
#[https://github.com/pparghod/reimplementation-back-end Github Repo]
#[https://github.com/expertiza/reimplementation-back-end/pull/10 Link to initial pull request]
#[https://github.com/users/pparghod/projects/2/views/1 GitHub Project Board]

CSC/ECE 517 Spring 2023 - E2320. Reimplement the Question Hierarchy

2023-04-08T00:34:27Z

Cbritt:

Design Doc

==Problem Statement==
The current implementation of the question hierarchy is not very clean and contains confusing variable and method names. Also, many methods return long HTML strings which are difficult to read. The goal of this project is to reimplement this part of the application to make it more readable, understandable and maintainable.

===Explanation of Feature - Question Hierarchy===
The Question class and its sub-classes are used to implement all rubric items, quiz questions, and survey questions in Expertiza. For example, a professor could use this feature to make up a review quiz for their class. There are 3 main types of questions in Experitza: scored, unscored, and upload file.

Here is the hierarchy:

'''1. Choice question'''
* Scored question
** Scale
** Criterion
* Unscored question
** Dropdown
** Multiple Choice
** Check Box
'''2. Text Response'''
* Text Area
* Text Field
'''3. Upload File'''

Choice questions are types of questions that give the quiz taker a list of answers to choose from. It is broken into two subcategories scored and unscored. Scored question will give a number value depending upon if a user clicks on a particular answer. The unscored questions don't have a score associated with them and come in a few different styles. The answers could be presented in a dropdown menu which only shows the answer choices after the user clicks on the dropdown arrow and clicks on an answer. Multiple choice questions present all the answers choices with a selectable bubble beside them and allow the user to click on the bubble to indicate their answer. Checkboxes are similar to multiple choice in that they present all of the answer choices at once however, the user must click on a certain number of boxes beside the answers they think are correct.

Text response questions are different in that they allow the user to actually type in their answer instead of just being provided answers. A text area question has a height and width associated with it that can be adjusted while a text field question is just 1 input line that does not change shape.

The last type of question is upload file which allows the user to upload a file to use as a quiz (as the name suggests). This option allows a person to upload a pre-made quiz document to be which will be converted into a quiz. So, a professor could type up their quiz questions and answers in a text file then choose upload and have Expertiza convert it into a quiz for them.

===List of Work Done so Far===
The following list describes tasks that were accomplished in Program 3:
* Improved naming of variables and methods
* Included comments for further clarification
* Implemented partials to deal with the HTML strings
* Added RSpec test cases

==Plan of work==

Based on the feedback provided to us by both our mentors and also peer reviews our team has decided upon a few key design goals to work on for the continuation of our work into Program 4. These goals are outlined below.

===Design Goals===
* Update code comments - Some methods and classes currently do not have any code comments, while other comments are not in depth enough to give proper context for functionality. One of our design goals will be to write more in depth comments that better explain functionality for the code. The below files are the ones which we plan too add more comments to:
**questionnaires_controller.rb
**checkbox.rb
**question.rb
**text_area.rb
**text_response.rb
* DRY out code with partials - Implement additional partials for certain classes. In program 3 our team had started to create partials for the 3 major types of questions. As we continue with program 4 we are going to continue to add more partials by looking at the similarities between all three types and pull out the similarities into a new class
**Ex: Question_Controller - Since all of the sub-categories inherit from the Question class we plan to make a question controller to hold all of the common functionality. One example of this can be seen with the method call 'edit' which exists in many of the subclasses like text_response.rb, text_area.rb, scale.rb, and criterion.rb. The partials will be moved into the question controller.

== Tests ==

'''RSpec'''

We reimplemented the test cases to match the changes we've made to the question-related models. Front-end testing wasn't necessary because our project doesn't involve changing any controller.

The most notable models that were tested are:
checkbox.rb
criterion.rb
dropdown.rb
multiple_choice_checkbox.rb
multiple_choice_radio.rb
scale.rb
text_area.rb
text_field.rb
text_response.rb
upload_file.rb

One of the primary goals we had were to make sure that the existing tests still passed. Several tests were removed for the edit methods in a few of the models (such as checkbox_spec.rb and dropdown_spec.rb) because those methods were replaced with partials. Partials have not been fully implemented which is why we did not include tests for them. However, this is something that should be revisited in the future.

Given below is an example of the tests we've written:
describe Dropdown do
let!(:dropdown) { Dropdown.create(id: 4, type: 'Dropdown', seq: 4.0, txt: 'Test text', weight: 13) }
let!(:answer) { Answer.create(id: 1, question_id: 4, questionnaire_type_id: 1, answer: 1, comments: "Test comment") }
describe '#view_question_text' do
it 'returns the html' do
html = dropdown.view_question_text
expect(html).to eq('<TR><TD align="left"> Test text </TD><TD align="left">Dropdown</TD><td align="center">13</TD><TD align="center">—</TD></TR>')
end
end
describe '#view_completed_question' do
it 'returns the html' do
html = dropdown.view_completed_question(1, answer)
expect(html).to eq('<nowiki><b></nowiki>1. Test text<nowiki></b><BR></nowiki>&nbsp&nbsp&nbsp&nbspTest comment')
end
end
describe '#complete_for_alternatives' do
it 'returns the html' do
alternatives = ['Alternative 1', 'Alternative 2', 'Alternative 3']
html = dropdown.complete_for_alternatives(alternatives, answer)
expect(html).to eq('<option value="Alternative 1">Alternative 1</option><option value="Alternative 2">Alternative 2</option><option value="Alternative 3">Alternative 3</option>')
end
end
describe '#complete' do
it 'returns the html' do
alternatives = ['Alternative 1|Alternative 2|Alternative 3']
allow(dropdown).to receive(:alternatives).and_return(alternatives)
allow(dropdown).to receive(:complete_for_alternatives).and_return('')
html = dropdown.complete(1, answer)
<nowiki>expect(html).to eq('<p style="width: 80%;"><label for="responses_1"">Test text  </label>'
+ '<input id="responses_1_score" name="responses[1][score]" type="hidden" value="" style="min-width: 100px;">'
+ '<select id="responses_1_comments" label=Test text name="responses[1][comment]"></select></p>')</nowiki>
end
end
end

Given below is the full list of tests:

[[File:E2320-RSpec.png]]

==Conclusions / Future Work==
===Specific Tasks Completed===
[Will be updated near final submission deadline]

==Team==
=====Mentor=====
* Prof. Edward F. Gehringer
* Priyam Garg

=====Members=====
* Colleen Britt
* Kimberly Jones
* Priyanka Arghode
==References==

#[https://expertiza.ncsu.edu/ Expertiza]
#[https://stackoverflow.com/questions/3425971/organizing-partials-for-a-polymorphic-resource Organizing Partials]
#[https://www.amberbit.com/blog/2011/12/27/render-views-and-partials-outside-controllers-in-rails-3 Render Views and Partials Outside Controllers]
#[https://github.com/pparghod/reimplementation-back-end Github Repo]
#[https://github.com/expertiza/reimplementation-back-end/pull/10 Link to initial pull request]
#[https://github.com/users/pparghod/projects/2/views/1 GitHub Project Board]

File:E2320-RSpec.png

2023-04-08T00:17:39Z

Cbritt:

CSC/ECE 517 Spring 2023 - E2320. Reimplement the Question hierarchy

2023-03-28T00:48:19Z

Cbritt:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Problem Statement==
The current implementation of the question hierarchy is not very clean and contains confusing variable and method names. Also, many methods return long HTML strings which are difficult to read. The goal of this project is to reimplement this part of the application to make it more readable, understandable and maintainable.

Tasks that were accomplished:
* Improved naming of variables and methods
* Included comments for further clarification
* Implemented partials to deal with the HTML strings
* Added RSpec test cases

==Question Hierarchy==

The Question class and its sub-classes are used to implement all rubric items, quiz questions, and survey questions in Expertiza.

Here is the hierarchy:

'''1. Choice question'''
* Scored question
** Scale
** Criterion
* Unscored question
** Dropdown
** Multiple Choice
** Check Box
'''2. Text Response'''
* Text Area
* Text Field
'''3. Upload File'''

==Files Modified==

There were multiple files that we needed to transfer from the old repository to make the models work, and we've had to comment out a lot of code. There were many file dependencies regarding questionnaires and questions. We've minimized it as much as we could to stay within the scope of our project.

Below are the files we changed or added in as part of the reimplementation.

questionnaires_controller.rb
answer.rb
application_record.rb
assignment.rb
assignment_questionnaire.rb
checkbox.rb
choice_question.rb
criterion.rb
dropdown.rb
multiple_choice_checkbox.rb
multiple_choice_radio.rb
question.rb
question_advice.rb
questionnaire.rb
quiz_question.rb
quiz_question_choice.rb
role.rb
scale.rb
scored_question.rb
text_area.rb
text_field.rb
text_response.rb
unscored_question.rb
upload_file.rb
user.rb

==Reimplementation==
As a part of the reimplementation project, migrations were created, added relevant old code files and partials are included in the old code files to avoid HTML concatenation. There exist many cases in the Question hierarchy were HTML string concatenation is being used to generate a view. In order to reduce duplicated code and DRY it out we added partials to replace the existing HTML string. This will help to keep the code cleaner and easier to maintain for future use.

'''Our code'''

Below is an example of a partial being used in the `criterion.rb` class file:

[[File:Partials1.PNG]]

Below is an example of a partial being used the `scale.rb` class file:

[[File:Partials2.PNG]]

Below shows the differences in code before and after adding the partial. While refactoring our code we found that this edit method was being duplicated between the Criterion class and the Scale class. Now after using a partial, the large chunk of duplicated code is simplified into a one line partial. This will help future developers who wish to make an change to the edit method without having to change multiple files.

[[File:7.PNG]]
----

Other refactoring changes we worked on included updating variable names for some of the models and migrations. Below are some snapshots of our code where these changes were made:
[[File:1.PNG]]

[[File:3.PNG]]

----

Another refactoring change we worked on was adding correct comments to the code for better readability and explanation of the code. Below are a few examples:

[[File:5.PNG]]

[[File:6.PNG]]

== Testing Plan ==

'''RSpec'''

We reimplemented the test cases to match the changes we've made to the question-related models. Front-end testing wasn't necessary because our project doesn't involve changing any controller.

The most notable models that were tested are:
checkbox.rb
criterion.rb
dropdown.rb
multiple_choice_checkbox.rb
multiple_choice_radio.rb
scale.rb
text_area.rb
text_field.rb
text_response.rb
upload_file.rb

== Next Steps ==
'''Continue to DRY out code using partials'''
* There are still many more files and sections of code that could benefit from the use of partials that we were unable to finish for round 1 (Ex: UploadFile). As we move into round 2, we will continue to look for more refactoring opportunities in order to better utilize partials.
'''More testing'''
* Since testing is a crucial element of this project we will continue to work on developing tests for our code changes.
'''Implement Front-end'''
* We've implemented the back-end part of the project but not the front-end. We've added several "views" files to make use of partials, so the front-end could be implemented by updating them and implementing the rest of the Rails application. It's also possible to create an entirely new front-end by using JavaScript and React.

==Team==
=====Mentor=====
* Prof. Edward F. Gehringer
* Priyam Garg

=====Members=====
* Colleen Britt
* Kimberly Jones
* Priyanka Arghode

==References==

#[https://expertiza.ncsu.edu/ Expertiza]
#[https://stackoverflow.com/questions/3425971/organizing-partials-for-a-polymorphic-resource Organizing Partials]
#[https://www.amberbit.com/blog/2011/12/27/render-views-and-partials-outside-controllers-in-rails-3 Render Views and Partials Outside Controllers]
#[https://github.com/pparghod/reimplementation-back-end Github Repo]
#[https://github.com/expertiza/reimplementation-back-end/pull/10 Link to initial pull request]
#[https://github.com/users/pparghod/projects/2/views/1 GitHub Project Board]

CSC/ECE 517 Spring 2023 - E2320. Reimplement the Question hierarchy

2023-03-22T23:27:56Z

Cbritt:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Problem Statement==
The current implementation of the question hierarchy is not very clean and contains confusing variable and method names. Also, many methods return long HTML strings which are difficult to read. The goal of this project is to reimplement this part of the application to make it more readable, understandable and maintainable.

Tasks that were accomplished:
* Improved naming of variables and methods
* Included comments for further clarification
* Implemented partials to deal with the HTML strings
* Added RSpec test cases

==Question Hierarchy==

The Question class and its sub-classes are used to implement all rubric items, quiz questions, and survey questions in Expertiza.

Here is the hierarchy:
=====1. Choice question=====
* Scored question
** Scale
** Criterion
* Unscored question
** Dropdown
** Multiple Choice
** Check Box
=====2. Text Response=====
* Text Area
* Text Field
=====3. Upload File=====

==Files Modified==

Below are the files we changed as part of the reimplementation.

question.rb
scale.rb
criterion.rb
text_area.rb
text_field.rb
text_response.rb
questionnaires_controller.rb
answer.rb
checkbox.rb
choice_question.rb
dropdown.rb
multiple_choice_checkbox.rb
multiple_choice_radio.rb
question.rb
question_advice.rb
questionnaire.rb
quiz_question.rb
quiz_question_choice.rb
scored_question.rb
unscored_question.rb
assignment_questionnaire.rb

==Reimplementation==
As a part of the reimplementation project, migrations were created, added relevant old code files and partials are included in the old code files to avoid HTML concatenation. There exist many cases in the Question hierarchy were HTML string concatenation is being used to generate a view. In order to reduce duplicated code and DRY it out we added partials to replace the existing HTML string. This will help to keep the code cleaner and easier to maintain for future use.

'''Our code'''

Below is an example of a partial being used in the `criterion.rb` class file:
[[File:Partials1.PNG]]

Below is an example of a partial being used the `scale.rb` class file:
[[File:Partials2.PNG]]

Below shows the differences in code before and after adding the partial. While refactoring our code we found that this edit method was being duplicated between the Criterion class and the Scale class. Now after using a partial, the large chunk of duplicated code is simplified into a one line partial. This will help future developers who wish to make an change to the edit method without having to change multiple files.

[[File:7.PNG]]
----

Other refactoring changes we worked on included updating variable names for some of the models and migrations. Below are some snapshots of our code where these changes were made:
[[File:1.PNG]]

[[File:3.PNG]]

----

Another refactoring change we worked on was adding correct comments to the code for better readability and explanation of the code. Below are a few examples:

[[File:5.PNG]]

[[File:6.PNG]]

== Testing Plan ==
=====RSpec=====
We reimplemented the test cases to match the changes we've made to the question-related models. Front-end testing wasn't necessary because our project doesn't involve changing any controller.

The most notable models are:
* checkbox.rb
* criterion.rb
* dropdown.rb
* multiple_choice_checkbox.rb
* multiple_choice_radio.rb
* scale.rb
* text_area.rb
* text_field.rb
* text_response.rb

== Next Steps ==
* Continue to DRY out code using partials - There are still many more files and sections of code that could benefit from the use of partials that we were unable to finish for round 1 (Ex: UploadFile). As we move into round 2 we will continue to look for more refactoring opportunities in order to better utilize partials.
* Finish testing - Since testing is a crucial element of this project we will continue to work on developing tests for our code changes. We were unable to finish testing for a few classes (Scored Question, TextResponse)

==Team==
=====Mentor=====
* Prof. Edward F. Gehringer
* Priyam Garg

=====Members=====
* Colleen Britt
* Kimberly Jones
* Priyanka Arghode

==References==

#[https://expertiza.ncsu.edu/ Expertiza]
#[https://stackoverflow.com/questions/3425971/organizing-partials-for-a-polymorphic-resource Organizing Partials]
#[https://www.amberbit.com/blog/2011/12/27/render-views-and-partials-outside-controllers-in-rails-3 Render Views and Partials Outside Controllers]
#[https://github.com/pparghod/reimplementation-back-end Github Repo]
#[https://github.com/expertiza/reimplementation-back-end/pull/10 Link to initial pull request]
#[https://github.com/users/pparghod/projects/2/views/1 GitHub Project Board]