Expertiza_Wiki - User contributions [en]

E1929 Visualizations for Instructors

2019-04-08T21:05:06Z

Jwarren3: /* Tools and Design Choices */

== Introduction ==
It is the desire of all instructors to emphasize course material that students have trouble understanding and de-emphasize those aspects of the course material which students readily grasp. One method used by instructors is the creation of questionnaires, or rubrics. A rubric consists of a number of questions, or criterion, that give instructors a glimpse into student understanding of course materials. Use of rubrics and their association with a course assignment allow instructors to find-tune their lesson plans to their students' understanding.

Creation of assignments, and their associated rubrics, can be a daunting task that can be made easier through the use of online platforms. Expertiza is one such online assignment grading platform. Within Expertiza, instructors create courses and assignments. For each assignment, instructors create one or more peer review rubrics for students to complete. After each round of rubrics, students can submit changes to their assignment based on these rubrics, with each submission and rubric considered a round. Hence, assignments have multiple rounds with each round associated with a rubric.

Instructors use the association between the assignment and the submitted rubric(s) associated with the assignment to understand what subjects need more focus. For example, a low average score on a rubric's particular question, or criterion, can indicate that the class has issues with a particular part of the assignment. Currently, instructors using Expertiza display assignment scores on one pages, but need to visit a completely separate page to display rubric scores. This separation of information hinders the instructor's ability to fully comprehend the associations between the assignment scores and the rubric scores. This, in turn, minimizes the likelihood that instructors will integrate this information to fine-tune their course material.

This project proposes to overcome this weakness in Expertiza by integrating the display of assignment scores and rubric scores onto a single page. This integration will allow instructors to more easily associate low rubric average scores with assignment scores. The ability to visualize assignment scores and rubric scores in a single location will reduce the workload on instructors when the scores. This, in turn, will increase the likelihood that instructors will change their lesson plans to reflect the students' understanding of the course material.

__TOC__

== Proposed Changes ==
To help instructors understand the relationship between assignment scores and rubric scores, this project proposes two types of visualizations. The first type of visualization allows instructors to examine the rubric statistics for a single assignment. The second type of visualization allows instructors to compare the rubric statistics between two different assignments when the criteria for each assignment is the same.

=== Existing Views ===

In both cases, the project will add rubric statistics to the assignment grade view. The current assignment grade view consists of a header containing grade statistics followed by a table of the individual grades. In the assignment grade view header, the left side fo the header shows the average assignment grade as a circle, while the right side of the assignment grade view header shows the assignment grade distribution. Figure 1 shows the current header in the grade assignment view page.

[[File:Existing_Assignment_Grades.JPG|frame|centre|Figure 1: Existing assignment grade page header. The existing assignment grade page header has both the average grade for the assignment and the grade distribution for the assignment. The left side shows the average as the percentage of a circle. The right side of the header shows the grade distribution for the assignment. The grade distribution shows the minimum and maximum grade for the assignment. Under the header is a list of the grades for each student.]]

The changes proposed by this project integrate rubric statistics to the above assignment grade view. Rubric statistic integration into the assignment grade view allow two types of visualizations. The first visualization allows the instructor to display rubric statistics within a single assignment. The second visualization allows the instructor to display rubric statistics between different assignments in the same course.

=== Proposed Assignment Grade Visualization ===

This project proposes the integration of rubric statistic visualization for both single assignments and multiple assignments into the assignment grade view. The integration occurs with a single change to the header of the assignment grade view, and retains the list of student grades. The following HTML mock-up shows the proposed changes to the header. The list of student grades is not changed and therefore not shown.

https://jwarren3.github.io/expertiza/tabs.html

The upper part of the rubric statistic visualization displays a set of tabs that allow the instructor to analyze the rubric within a single assignment or to compare the rubric statistics between multiple assignments. The middle part of the rubric statistic visualization displays the statistics for each selected criteria as a bar graph. The heights of the bars are shown as a percentage of the maximum value for each criteria. The bottom part of the rubric statistic visualization displays a set of options that allow the instructor to filter the statistics shown in the bar graph. The left side (assignment average) and right side (assignment distribution) of the assignment grade view header are not changed.

In the integration of the rubric statistic visualization mock-up within a single assignment, there are two rounds of rubrics for the students to fill out. The rubric in round 1 consisted of five criteria, while the rubric in round 2 consisted of 4 criteria. The round of interest is selected using the drop-down menu on the left side. The criteria shown in the bar graph are selected using radio buttons next to each criterion. Finally, the type of statistic shown is selected using a drop-down menu on the right side of the options. Currently, the statistic is limited to either mean or median. Hovering the mouse over each of the bars in the bar graph shows the numerical value of the chosen statistic.

Visualizing the rubric statistics within a single assignment starts by selecting the left tab titled "Analyze Assignment". The default displays the mean of all criteria from the first round. Changing the round, the type of statistic, and the particular criteria are controlled from the drop-down menus and radio buttons below the bar graph.

Visualizing the rubric statistics between assignments starts by selecting the right tab titled "Compare Assignments". The default displays the comparisons between round one and all criteria of an assignment in the same course. The default assignment is the chronologically earliest assignment. The current assignment is shown in red while the rubric being compared is shown in blue.

== Project Design ==
This project expects to change controller files, view files, JavaScript files, and RSpec files. This project does not expect to change any model files, though models will be changed if model data needs to be reformatted. This project does not expect to change the database.

=== Design Flow ===
Instructor wants to view student scores on individual rubric criteria:

[[File:DesignFlowSingle.png]]

Instructor wants to compare student scores on individual rubric criteria between two compatible rounds of two different assignments:

[[File:DesignFlowCompare.png]]

=== Tools and Design Choices ===
This project proposes using a third party JavaScript library for rendering the rubric statistics. This project proposes two requirements for the visualization library. The first requirement is to use a visualization library that performs client-side rendering. Using a client-side rendering library will minimize the number of server interactions as the instructor changes which rubric statistics to display. This minimization of server interaction will maximize the response time of Expertiza.

The second requirement for the visualization library is compatibility with current Expertiza graphics. The compatibility requirement implies that the visualization library is one that is already being used in Expertiza or a visualization library that could be used to render the current graphics.

Examples of client-side visualization libraries are given below:

Highcharts (http://www.highcharts.com/)
RaphaelJS (http://g.raphaeljs.com/)
dygraphs (http://dygraphs.com/)
Protovis (http://vis.stanford.edu/protovis/)
Grafico (http://grafico.kilianvalkhof.com/)
ChartKick (https://chartkick.com/)
VanCharts (http://www.vancharts.com/)
GoogleCharts (https://developers.google.com/chart/)

== Test Plan ==
The team plans to perform both automated tests using frameworks RSpec and Capybara. In addition, we will perform manual tests of the user interface (UI), using the app.

=== RSpec Framework Tests ===
The RSpec Testing Framework, automated testing, will be used to verify the Models of the Expertiza Rails Web application feature set. Since this feature is dealing with Visualizations (charts) that is intimately tied with an Active Record Models, we will seed the Testing Database with known data via RSpec. These changes will be automatically rolled-back once the testing is complete.

=== Capybara Tests ===
Another automated testing framework that will be used is Capybara. Capybara is an browser type test to simulate a user clicking through your site. We will use this testing framework to verify that our charting object is present on the page and contains the seeded data that we had loaded.

=== UI Tests ===
In addition to the automated tests above we will also perform manual testing of the newly added features to include:

* Chart is displaying correctly
*# Bars are showing up where expected
*# Bar annotations are showing the expected value
*# Criteria labels are for the correct bar and displaying correct values
*# Hover text is displaying the correct values
*# Null values are not present on the chart
*# Correct colors are used for the multi-round view
* Show Labels checkbox works as expected
* Round Criteria is displaying correctly
*# Round dropdown menu shows all rounds for the assignment
*# Selecting a round changes the criteria checkboxes
*# All checkboxes are displayed with appropriate text
*# Checkboxes correctly remove or add criterion bars to the chart

== Files Involved ==

== Test Results ==
The team ran both automated tests, using the RSpec framework, and manual tests of the user interface (UI), using the app. The automated tests helped to ensure that the basic functionality of the app still worked, while the UI tests ensured that the visualizations were correct.

=== RSpec Test Results ===

=== UI Tests ===

CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires controller.rb

2019-04-02T02:12:42Z

Jwarren3: /* Test Plan */

__TOC__

===Description of the project===
The questionnaires controller had several issues; this project aimed to address some of them, including:

* Remove or move logic that should reside elsewhere, e.g. in a model class.
* Remove logic and references to logic that is no longer being used.

===Files modified in the project===
# app/controllers/questionnaires_controller.rb
# app/models/questionnaire.rb
# app/views/questionnaires/_questionnaire.html.erb
# app/views/questionnaires/edit_questionnaire.html.erb (deleted)
# spec/controllers/questionnaires_controller_spec.rb
# spec/models/questionnaire_spec.rb

===Issues and Improvements===

====The ''assign_instructor_id'' method====

=====Problems=====
This method had two issues:
# Its name was misleading because it did not actually assign a value; it simply obtained a value from the user in the session.
# It was delving into implementation details of the ''User'' class.

=====Solution=====
The equivalent logic was already implemented in the ''User'' class's ''instructor_id'' method, so calls to the ''assign_instructor_id'' method were simply replaced with:
<pre>
session[:user].instructor_id
</pre>

A description in ''spec/controllers/questionnaires_controller_spec.rb'' was updated to reflect that ''assign_instructor_id'' was no longer in scope.

====The ''export'' and ''import'' methods====

=====Problems=====
These methods were actually no longer being used, because the functionality they provided was moved to the ''export_file'' and ''import_file'' routes.

=====Solution=====
* The logic was triggered by the presence of the parameters ''import'' or ''export'' in the ''save_all_questions'' action. Code that caused these parameters to be present had been commented out of ''_questionnaire.html.erb'' and ''edit_questionnaire.html.erb'' in the questionnaire views. The latter file was no longer reachable, as there was no reference to an ''edit_questionnaire'' action in ''config/routes.rb'' or any direct references to it in the questionnaires controller itself. Thus the commented-out code was removed from ''_questionnaire.html.erb'' and the ''edit_questionnaire.html.erb'' file was deleted.
* The logic referencing the parameters and methods was removed from the ''save_all_questions'' method.

====The 'copy' and 'copy_questionnaire_details' methods====

=====Problems=====

#There were two methods ''copy'' and ''copy_questionnaire_details'' present in app/controllers/questionnaire_controller.rb which implemented just one functionality of making a copy of a particular questionnaire.
#There was no need of two methods in the controller itself. Also, some parts of what was happening needed to be in the model.

=====Solution=====
* Nothing special was happening in the ''copy_questionnaire_details'' method. Also, it needed to be placed into the model because of the nature of things happening inside it.
* So, now we have one method ''copy'' in the controller, which calls the ''copy_questionnaire_details'' method, which is present in the Questionnaire model. The instructor_id as well as the params are passed as arguments to the ''copy_questionnaire_details'' method.
* The other methods that the older ''copy_questionnaire_details'' methods used to call, like ''assign_instructor_id'' were removed in the changes above and they are now included in the method in the model itself.
* The Exception (if it occurs while saving the Questionnaire object) is being handled in the ''copy'' method of the controller so that the user can be redirected easily.

====Making code DRYer====

=====Problems=====

#There were parts of the code, specifically when QuizQuestionChoice was created, which was copied throughout the questionnaires_controller.rb.

=====Solution=====
* To make the code DRYer, the repeating code sequences were added into a function called ''create_quiz_question_choice''.
* Calls were made to this method wherever QuizQuestionChoice was made.

=== Test Plan ===
There is no means of testing the removal of dead code, except to run the existing suite of test cases:
<pre>
rspec spec
</pre>
Removal of the ''assign_instructor_id'' method can be tested by running test cases for the questionnaires controller, since existing test cases rely on the instructor ID being retrieved correctly:
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>
Testing the method ''create_quiz_question_choice'' can likewise be done with this command.
The logic associated with getting the instructor ID from a user is tested using
<pre>
rspec spec/models/user_spec.rb
</pre>
The additions to the questionnaires model can be tested using
<pre>
rspec spec/models/questionnaire_spec.rb
</pre>
Note: If you are having difficulties running the ''rspec'' command, try using
<pre>
bundle exec rspec
</pre>
instead. This will use the gems specified in ''Gemfile'' that were installed via ''bundle install''.

CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires controller.rb

2019-04-02T02:07:11Z

Jwarren3: /* Files modified in the project */

__TOC__

===Description of the project===
The questionnaires controller had several issues; this project aimed to address some of them, including:

* Remove or move logic that should reside elsewhere, e.g. in a model class.
* Remove logic and references to logic that is no longer being used.

===Files modified in the project===
# app/controllers/questionnaires_controller.rb
# app/models/questionnaire.rb
# app/views/questionnaires/_questionnaire.html.erb
# app/views/questionnaires/edit_questionnaire.html.erb (deleted)
# spec/controllers/questionnaires_controller_spec.rb
# spec/models/questionnaire_spec.rb

===Issues and Improvements===

====The ''assign_instructor_id'' method====

=====Problems=====
This method had two issues:
# Its name was misleading because it did not actually assign a value; it simply obtained a value from the user in the session.
# It was delving into implementation details of the ''User'' class.

=====Solution=====
The equivalent logic was already implemented in the ''User'' class's ''instructor_id'' method, so calls to the ''assign_instructor_id'' method were simply replaced with:
<pre>
session[:user].instructor_id
</pre>

A description in ''spec/controllers/questionnaires_controller_spec.rb'' was updated to reflect that ''assign_instructor_id'' was no longer in scope.

====The ''export'' and ''import'' methods====

=====Problems=====
These methods were actually no longer being used, because the functionality they provided was moved to the ''export_file'' and ''import_file'' routes.

=====Solution=====
* The logic was triggered by the presence of the parameters ''import'' or ''export'' in the ''save_all_questions'' action. Code that caused these parameters to be present had been commented out of ''_questionnaire.html.erb'' and ''edit_questionnaire.html.erb'' in the questionnaire views. The latter file was no longer reachable, as there was no reference to an ''edit_questionnaire'' action in ''config/routes.rb'' or any direct references to it in the questionnaires controller itself. Thus the commented-out code was removed from ''_questionnaire.html.erb'' and the ''edit_questionnaire.html.erb'' file was deleted.
* The logic referencing the parameters and methods was removed from the ''save_all_questions'' method.

====The 'copy' and 'copy_questionnaire_details' methods====

=====Problems=====

#There were two methods ''copy'' and ''copy_questionnaire_details'' present in app/controllers/questionnaire_controller.rb which implemented just one functionality of making a copy of a particular questionnaire.
#There was no need of two methods in the controller itself. Also, some parts of what was happening needed to be in the model.

=====Solution=====
* Nothing special was happening in the ''copy_questionnaire_details'' method. Also, it needed to be placed into the model because of the nature of things happening inside it.
* So, now we have one method ''copy'' in the controller, which calls the ''copy_questionnaire_details'' method, which is present in the Questionnaire model. The instructor_id as well as the params are passed as arguments to the ''copy_questionnaire_details'' method.
* The other methods that the older ''copy_questionnaire_details'' methods used to call, like ''assign_instructor_id'' were removed in the changes above and they are now included in the method in the model itself.
* The Exception (if it occurs while saving the Questionnaire object) is being handled in the ''copy'' method of the controller so that the user can be redirected easily.

====Making code DRYer====

=====Problems=====

#There were parts of the code, specifically when QuizQuestionChoice was created, which was copied throughout the questionnaires_controller.rb.

=====Solution=====
* To make the code DRYer, the repeating code sequences were added into a function called ''create_quiz_question_choice''.
* Calls were made to this method wherever QuizQuestionChoice was made.

=== Test Plan ===
There is no means of testing the removal of dead code, except to run the existing suite of test cases:
<pre>
rspec spec
</pre>
Removal of the ''assign_instructor_id'' method can be tested by running test cases for the questionnaires controller, since existing test cases rely on the instructor ID being retrieved correctly:
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>
The logic associated with getting the instructor ID from a user is tested using
<pre>
rspec spec/models/user_spec.rb
</pre>
The additions to the questionnaires model can be tested using
<pre>
rspec spec/models/questionnaire_spec.rb
</pre>
Note: If you are having difficulties running the ''rspec'' command, try using
<pre>
bundle exec rspec
</pre>
instead. This will use the gems specified in ''Gemfile'' that were installed via ''bundle install''.

CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires controller.rb

2019-04-02T02:05:15Z

Jwarren3: /* Test Plan */

__TOC__

===Description of the project===
The questionnaires controller had several issues; this project aimed to address some of them, including:

* Remove or move logic that should reside elsewhere, e.g. in a model class.
* Remove logic and references to logic that is no longer being used.

===Files modified in the project===
# app/controllers/questionnaires_controller.rb
# app/models/questionnaire.rb
# app/views/questionnaires/_questionnaire.html.erb
# app/views/questionnaires/edit_questionnaire.html.erb (deleted)
# spec/controllers/questionnaires_controller_spec.rb

===Issues and Improvements===

====The ''assign_instructor_id'' method====

=====Problems=====
This method had two issues:
# Its name was misleading because it did not actually assign a value; it simply obtained a value from the user in the session.
# It was delving into implementation details of the ''User'' class.

=====Solution=====
The equivalent logic was already implemented in the ''User'' class's ''instructor_id'' method, so calls to the ''assign_instructor_id'' method were simply replaced with:
<pre>
session[:user].instructor_id
</pre>

A description in ''spec/controllers/questionnaires_controller_spec.rb'' was updated to reflect that ''assign_instructor_id'' was no longer in scope.

====The ''export'' and ''import'' methods====

=====Problems=====
These methods were actually no longer being used, because the functionality they provided was moved to the ''export_file'' and ''import_file'' routes.

=====Solution=====
* The logic was triggered by the presence of the parameters ''import'' or ''export'' in the ''save_all_questions'' action. Code that caused these parameters to be present had been commented out of ''_questionnaire.html.erb'' and ''edit_questionnaire.html.erb'' in the questionnaire views. The latter file was no longer reachable, as there was no reference to an ''edit_questionnaire'' action in ''config/routes.rb'' or any direct references to it in the questionnaires controller itself. Thus the commented-out code was removed from ''_questionnaire.html.erb'' and the ''edit_questionnaire.html.erb'' file was deleted.
* The logic referencing the parameters and methods was removed from the ''save_all_questions'' method.

====The 'copy' and 'copy_questionnaire_details' methods====

=====Problems=====

#There were two methods ''copy'' and ''copy_questionnaire_details'' present in app/controllers/questionnaire_controller.rb which implemented just one functionality of making a copy of a particular questionnaire.
#There was no need of two methods in the controller itself. Also, some parts of what was happening needed to be in the model.

=====Solution=====
* Nothing special was happening in the ''copy_questionnaire_details'' method. Also, it needed to be placed into the model because of the nature of things happening inside it.
* So, now we have one method ''copy'' in the controller, which calls the ''copy_questionnaire_details'' method, which is present in the Questionnaire model. The instructor_id as well as the params are passed as arguments to the ''copy_questionnaire_details'' method.
* The other methods that the older ''copy_questionnaire_details'' methods used to call, like ''assign_instructor_id'' were removed in the changes above and they are now included in the method in the model itself.
* The Exception (if it occurs while saving the Questionnaire object) is being handled in the ''copy'' method of the controller so that the user can be redirected easily.

====Making code DRYer====

=====Problems=====

#There were parts of the code, specifically when QuizQuestionChoice was created, which was copied throughout the questionnaires_controller.rb.

=====Solution=====
* To make the code DRYer, the repeating code sequences were added into a function called ''create_quiz_question_choice''.
* Calls were made to this method wherever QuizQuestionChoice was made.

=== Test Plan ===
There is no means of testing the removal of dead code, except to run the existing suite of test cases:
<pre>
rspec spec
</pre>
Removal of the ''assign_instructor_id'' method can be tested by running test cases for the questionnaires controller, since existing test cases rely on the instructor ID being retrieved correctly:
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>
The logic associated with getting the instructor ID from a user is tested using
<pre>
rspec spec/models/user_spec.rb
</pre>
The additions to the questionnaires model can be tested using
<pre>
rspec spec/models/questionnaire_spec.rb
</pre>
Note: If you are having difficulties running the ''rspec'' command, try using
<pre>
bundle exec rspec
</pre>
instead. This will use the gems specified in ''Gemfile'' that were installed via ''bundle install''.

CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires controller.rb

2019-04-02T02:04:53Z

Jwarren3: /* Test Plan */

__TOC__

===Description of the project===
The questionnaires controller had several issues; this project aimed to address some of them, including:

* Remove or move logic that should reside elsewhere, e.g. in a model class.
* Remove logic and references to logic that is no longer being used.

===Files modified in the project===
# app/controllers/questionnaires_controller.rb
# app/models/questionnaire.rb
# app/views/questionnaires/_questionnaire.html.erb
# app/views/questionnaires/edit_questionnaire.html.erb (deleted)
# spec/controllers/questionnaires_controller_spec.rb

===Issues and Improvements===

====The ''assign_instructor_id'' method====

=====Problems=====
This method had two issues:
# Its name was misleading because it did not actually assign a value; it simply obtained a value from the user in the session.
# It was delving into implementation details of the ''User'' class.

=====Solution=====
The equivalent logic was already implemented in the ''User'' class's ''instructor_id'' method, so calls to the ''assign_instructor_id'' method were simply replaced with:
<pre>
session[:user].instructor_id
</pre>

A description in ''spec/controllers/questionnaires_controller_spec.rb'' was updated to reflect that ''assign_instructor_id'' was no longer in scope.

====The ''export'' and ''import'' methods====

=====Problems=====
These methods were actually no longer being used, because the functionality they provided was moved to the ''export_file'' and ''import_file'' routes.

=====Solution=====
* The logic was triggered by the presence of the parameters ''import'' or ''export'' in the ''save_all_questions'' action. Code that caused these parameters to be present had been commented out of ''_questionnaire.html.erb'' and ''edit_questionnaire.html.erb'' in the questionnaire views. The latter file was no longer reachable, as there was no reference to an ''edit_questionnaire'' action in ''config/routes.rb'' or any direct references to it in the questionnaires controller itself. Thus the commented-out code was removed from ''_questionnaire.html.erb'' and the ''edit_questionnaire.html.erb'' file was deleted.
* The logic referencing the parameters and methods was removed from the ''save_all_questions'' method.

====The 'copy' and 'copy_questionnaire_details' methods====

=====Problems=====

#There were two methods ''copy'' and ''copy_questionnaire_details'' present in app/controllers/questionnaire_controller.rb which implemented just one functionality of making a copy of a particular questionnaire.
#There was no need of two methods in the controller itself. Also, some parts of what was happening needed to be in the model.

=====Solution=====
* Nothing special was happening in the ''copy_questionnaire_details'' method. Also, it needed to be placed into the model because of the nature of things happening inside it.
* So, now we have one method ''copy'' in the controller, which calls the ''copy_questionnaire_details'' method, which is present in the Questionnaire model. The instructor_id as well as the params are passed as arguments to the ''copy_questionnaire_details'' method.
* The other methods that the older ''copy_questionnaire_details'' methods used to call, like ''assign_instructor_id'' were removed in the changes above and they are now included in the method in the model itself.
* The Exception (if it occurs while saving the Questionnaire object) is being handled in the ''copy'' method of the controller so that the user can be redirected easily.

====Making code DRYer====

=====Problems=====

#There were parts of the code, specifically when QuizQuestionChoice was created, which was copied throughout the questionnaires_controller.rb.

=====Solution=====
* To make the code DRYer, the repeating code sequences were added into a function called ''create_quiz_question_choice''.
* Calls were made to this method wherever QuizQuestionChoice was made.

=== Test Plan ===
There is no means of testing the removal of dead code, except to run the existing suite of test cases:
<pre>
rspec spec
</pre>
Removal of the ''assign_instructor_id'' method can be tested by running test cases for the questionnaires controller, since existing test cases rely on the instructor ID being retrieved correctly:
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>
The logic associated with getting the instructor ID from a user is tested using
<pre>
rspec spec/models/user_spec.rb
</pre>
The additions to the questionnaires model can be tested using
<pre>
rspec spec/models/questionnaire_spec.rb
</pre>
Note: If you are having difficulties running the ''spec'' command, try using
<pre>
bundle exec rspec
</pre>
instead. This will use the gems specified in ''Gemfile'' that were installed via ''bundle install''.

CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires controller.rb

2019-04-02T02:04:38Z

Jwarren3: /* Test Plan */

__TOC__

===Description of the project===
The questionnaires controller had several issues; this project aimed to address some of them, including:

* Remove or move logic that should reside elsewhere, e.g. in a model class.
* Remove logic and references to logic that is no longer being used.

===Files modified in the project===
# app/controllers/questionnaires_controller.rb
# app/models/questionnaire.rb
# app/views/questionnaires/_questionnaire.html.erb
# app/views/questionnaires/edit_questionnaire.html.erb (deleted)
# spec/controllers/questionnaires_controller_spec.rb

===Issues and Improvements===

====The ''assign_instructor_id'' method====

=====Problems=====
This method had two issues:
# Its name was misleading because it did not actually assign a value; it simply obtained a value from the user in the session.
# It was delving into implementation details of the ''User'' class.

=====Solution=====
The equivalent logic was already implemented in the ''User'' class's ''instructor_id'' method, so calls to the ''assign_instructor_id'' method were simply replaced with:
<pre>
session[:user].instructor_id
</pre>

A description in ''spec/controllers/questionnaires_controller_spec.rb'' was updated to reflect that ''assign_instructor_id'' was no longer in scope.

====The ''export'' and ''import'' methods====

=====Problems=====
These methods were actually no longer being used, because the functionality they provided was moved to the ''export_file'' and ''import_file'' routes.

=====Solution=====
* The logic was triggered by the presence of the parameters ''import'' or ''export'' in the ''save_all_questions'' action. Code that caused these parameters to be present had been commented out of ''_questionnaire.html.erb'' and ''edit_questionnaire.html.erb'' in the questionnaire views. The latter file was no longer reachable, as there was no reference to an ''edit_questionnaire'' action in ''config/routes.rb'' or any direct references to it in the questionnaires controller itself. Thus the commented-out code was removed from ''_questionnaire.html.erb'' and the ''edit_questionnaire.html.erb'' file was deleted.
* The logic referencing the parameters and methods was removed from the ''save_all_questions'' method.

====The 'copy' and 'copy_questionnaire_details' methods====

=====Problems=====

#There were two methods ''copy'' and ''copy_questionnaire_details'' present in app/controllers/questionnaire_controller.rb which implemented just one functionality of making a copy of a particular questionnaire.
#There was no need of two methods in the controller itself. Also, some parts of what was happening needed to be in the model.

=====Solution=====
* Nothing special was happening in the ''copy_questionnaire_details'' method. Also, it needed to be placed into the model because of the nature of things happening inside it.
* So, now we have one method ''copy'' in the controller, which calls the ''copy_questionnaire_details'' method, which is present in the Questionnaire model. The instructor_id as well as the params are passed as arguments to the ''copy_questionnaire_details'' method.
* The other methods that the older ''copy_questionnaire_details'' methods used to call, like ''assign_instructor_id'' were removed in the changes above and they are now included in the method in the model itself.
* The Exception (if it occurs while saving the Questionnaire object) is being handled in the ''copy'' method of the controller so that the user can be redirected easily.

====Making code DRYer====

=====Problems=====

#There were parts of the code, specifically when QuizQuestionChoice was created, which was copied throughout the questionnaires_controller.rb.

=====Solution=====
* To make the code DRYer, the repeating code sequences were added into a function called ''create_quiz_question_choice''.
* Calls were made to this method wherever QuizQuestionChoice was made.

=== Test Plan ===
There is no means of testing the removal of dead code, except to run the existing suite of test cases:
<pre>
rspec spec
</pre>
Removal of the ''assign_instructor_id'' method can be tested by running test cases for the questionnaires controller, since existing test cases rely on the instructor ID being retrieved correctly:
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>
The logic associated with getting the instructor ID from a user is tested using
<pre>
rspec spec/models/user_spec.rb
</pre>
The additions to the questionnaires model can be tested using
<pre>
rspec spec/models/questionnaire_spec.rb
</pre>
Note: If you are having difficulties running the ''spec'' command, try using
<pre>
bundle exec spec
</pre>
instead. This will use the gems specified in ''Gemfile'' that were installed via ''bundle install''.

CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires controller.rb

2019-04-01T23:17:10Z

Jwarren3: /* Test Plan */

__TOC__

===Description of the project===
The questionnaires controller had several issues; this project aimed to address some of them, including:

* Remove or move logic that should reside elsewhere, e.g. in a model class.
* Remove logic and references to logic that is no longer being used.

===Files modified in the project===
# app/controllers/questionnaires_controller.rb
# app/models/questionnaire.rb
# app/views/questionnaires/_questionnaire.html.erb
# app/views/questionnaires/edit_questionnaire.html.erb (deleted)
# spec/controllers/questionnaires_controller_spec.rb

===Issues and Improvements===

====The ''assign_instructor_id'' method====

=====Problems=====
This method had two issues:
# Its name was misleading because it did not actually assign a value; it simply obtained a value from the user in the session.
# It was delving into implementation details of the ''User'' class.

=====Solution=====
The equivalent logic was already implemented in the ''User'' class's ''instructor_id'' method, so calls to the ''assign_instructor_id'' method were simply replaced with:
<pre>
session[:user].instructor_id
</pre>

A description in ''spec/controllers/questionnaires_controller_spec.rb'' was updated to reflect that ''assign_instructor_id'' was no longer in scope.

====The ''export'' and ''import'' methods====

=====Problems=====
These methods were actually no longer being used, because the functionality they provided was moved to the ''export_file'' and ''import_file'' routes.

=====Solution=====
* The logic was triggered by the presence of the parameters ''import'' or ''export'' in the ''save_all_questions'' action. Code that caused these parameters to be present had been commented out of ''_questionnaire.html.erb'' and ''edit_questionnaire.html.erb'' in the questionnaire views. The latter file was no longer reachable, as there was no reference to an ''edit_questionnaire'' action in ''config/routes.rb'' or any direct references to it in the questionnaires controller itself. Thus the commented-out code was removed from ''_questionnaire.html.erb'' and the ''edit_questionnaire.html.erb'' file was deleted.
* The logic referencing the parameters and methods was removed from the ''save_all_questions'' method.

====The 'copy' and 'copy_questionnaire_details' methods====

=====Problems=====

#There were two methods ''copy'' and ''copy_questionnaire_details'' present in app/controllers/questionnaire_controller.rb which implemented just one functionality of making a copy of a particular questionnaire.
#There was no need of two methods in the controller itself. Also, some parts of what was happening needed to be in the model.

=====Solution=====
* Nothing special was happening in the ''copy_questionnaire_details'' method. Also, it needed to be placed into the model because of the nature of things happening inside it.
* So, now we have one method ''copy'' in the controller, which calls the ''copy_questionnaire_details'' method, which is present in the Questionnaire model. The instructor_id as well as the params are passed as arguments to the ''copy_questionnaire_details'' method.
* The other methods that the older ''copy_questionnaire_details'' methods used to call, like ''assign_instructor_id'' were removed in the changes above and they are now included in the method in the model itself.
* The Exception (if it occurs while saving the Questionnaire object) is being handled in the ''copy'' method of the controller so that the user can be redirected easily.

====Making code DRYer====

=====Problems=====

#There were parts of the code, specifically when QuizQuestionChoice was created, which was copied throughout the questionnaires_controller.rb.

=====Solution=====
* To make the code DRYer, the repeating code sequences were added into a function called ''create_quiz_question_choice''.
* Calls were made to this method wherever QuizQuestionChoice was made.

=== Test Plan ===
There is no means of testing the removal of dead code, except to run the existing suite of test cases:
<pre>
rspec spec
</pre>
Removal of the ''assign_instructor_id'' method can be tested by running test cases for the questionnaires controller, since existing test cases rely on the instructor ID being retrieved correctly:
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>
The logic associated with getting the instructor ID from a user is tested using
<pre>
rspec spec/models/user_spec.rb
</pre>
The additions to the questionnaires model can be tested using
<pre>
rspec spec/models/questionnaire_spec.rb
</pre>

CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires controller.rb

2019-03-31T13:52:34Z

Jwarren3: /* Test Plan */

__TOC__

===Description of the project===
The questionnaires controller had several issues; this project aimed to address some of them, including:

* Remove or move logic that should reside elsewhere, e.g. in a model class.
* Remove logic and references to logic that is no longer being used.

===Files modified in the project===
# app/controllers/questionnaires_controller.rb
# app/models/questionnaire.rb
# app/views/questionnaires/_questionnaire.html.erb
# app/views/questionnaires/edit_questionnaire.html.erb (deleted)
# spec/controllers/questionnaires_controller_spec.rb

===Issues and Improvements===

====The ''assign_instructor_id'' method====

=====Problems=====
This method had two issues:
# Its name was misleading because it did not actually assign a value; it simply obtained a value from the user in the session.
# It was delving into implementation details of the ''User'' class.

=====Solution=====
The equivalent logic was already implemented in the ''User'' class's ''instructor_id'' method, so calls to the ''assign_instructor_id'' method were simply replaced with:
<pre>
session[:user].instructor_id
</pre>

A description in ''spec/controllers/questionnaires_controller_spec.rb'' was updated to reflect that ''assign_instructor_id'' was no longer in scope.

====The ''export'' and ''import'' methods====

=====Problems=====
These methods were actually no longer being used, because the functionality they provided was moved to the ''export_file'' and ''import_file'' routes.

=====Solution=====
* The logic was triggered by the presence of the parameters ''import'' or ''export'' in the ''save_all_questions'' action. Code that caused these parameters to be present had been commented out of ''_questionnaire.html.erb'' and ''edit_questionnaire.html.erb'' in the questionnaire views. The latter file was no longer reachable, as there was no reference to an ''edit_questionnaire'' action in ''config/routes.rb'' or any direct references to it in the questionnaires controller itself. Thus the commented-out code was removed from ''_questionnaire.html.erb'' and the ''edit_questionnaire.html.erb'' file was deleted.
* The logic referencing the parameters and methods was removed from the ''save_all_questions'' method.

====The 'copy' and 'copy_questionnaire_details' methods====

=====Problems=====

#There were two methods ''copy'' and ''copy_questionnaire_details'' present in app/controllers/questionnaire_controller.rb which implemented just one functionality of making a copy of a particular questionnaire.
#There was no need of two methods in the controller itself. Also, some parts of what was happening needed to be in the model.

=====Solution=====
* Nothing special was happening in the ''copy_questionnaire_details'' method. Also, it needed to be placed into the model because of the nature of things happening inside it.
* So, now we have one method ''copy'' in the controller, which calls the ''copy_questionnaire_details'' method, which is present in the Questionnaire model. The instructor_id as well as the params are passed as arguments to the ''copy_questionnaire_details'' method.
* The other methods that the older ''copy_questionnaire_details'' methods used to call, like ''assign_instructor_id'' were removed in the changes above and they are now included in the method in the model itself.
* The Exception (if it occurs while saving the Questionnaire object) is being handled in the ''copy'' method of the controller so that the user can be redirected easily.

====Making code DRYer====

=====Problems=====

#There were parts of the code, specifically when QuizQuestionChoice was created, which was copied throughout the questionnaires_controller.rb.

=====Solution=====
* To make the code DRYer, the repeating code sequences were added into a function called ''create_quiz_question_choice''.
* Calls were made to this method wherever QuizQuestionChoice was made.

=== Test Plan ===
There is no means of testing the removal of dead code, except to run the existing suite of test cases:
<pre>
rspec spec
</pre>
Removal of the ''assign_instructor_id'' method can be tested by running test cases for the questionnaires controller, since existing test cases rely on the instructor ID being retrieved correctly:
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>
The logic associated with getting the instructor ID from a user is tested using
<pre>
rspec spec/models/user_spec.rb
</pre>

CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires controller.rb

2019-03-31T13:47:20Z

Jwarren3: /* Test Plan */

__TOC__

===Description of the project===
The questionnaires controller had several issues; this project aimed to address some of them, including:

* Remove or move logic that should reside elsewhere, e.g. in a model class.
* Remove logic and references to logic that is no longer being used.

===Files modified in the project===
# app/controllers/questionnaires_controller.rb
# app/models/questionnaire.rb
# app/views/questionnaires/_questionnaire.html.erb
# app/views/questionnaires/edit_questionnaire.html.erb (deleted)
# spec/controllers/questionnaires_controller_spec.rb

===Issues and Improvements===

====The ''assign_instructor_id'' method====

=====Problems=====
This method had two issues:
# Its name was misleading because it did not actually assign a value; it simply obtained a value from the user in the session.
# It was delving into implementation details of the ''User'' class.

=====Solution=====
The equivalent logic was already implemented in the ''User'' class's ''instructor_id'' method, so calls to the ''assign_instructor_id'' method were simply replaced with:
<pre>
session[:user].instructor_id
</pre>

A description in ''spec/controllers/questionnaires_controller_spec.rb'' was updated to reflect that ''assign_instructor_id'' was no longer in scope.

====The ''export'' and ''import'' methods====

=====Problems=====
These methods were actually no longer being used, because the functionality they provided was moved to the ''export_file'' and ''import_file'' routes.

=====Solution=====
* The logic was triggered by the presence of the parameters ''import'' or ''export'' in the ''save_all_questions'' action. Code that caused these parameters to be present had been commented out of ''_questionnaire.html.erb'' and ''edit_questionnaire.html.erb'' in the questionnaire views. The latter file was no longer reachable, as there was no reference to an ''edit_questionnaire'' action in ''config/routes.rb'' or any direct references to it in the questionnaires controller itself. Thus the commented-out code was removed from ''_questionnaire.html.erb'' and the ''edit_questionnaire.html.erb'' file was deleted.
* The logic referencing the parameters and methods was removed from the ''save_all_questions'' method.

====The 'copy' and 'copy_questionnaire_details' methods====

=====Problems=====

#There were two methods ''copy'' and ''copy_questionnaire_details'' present in app/controllers/questionnaire_controller.rb which implemented just one functionality of making a copy of a particular questionnaire.
#There was no need of two methods in the controller itself. Also, some parts of what was happening needed to be in the model.

=====Solution=====
* Nothing special was happening in the ''copy_questionnaire_details'' method. Also, it needed to be placed into the model because of the nature of things happening inside it.
* So, now we have one method ''copy'' in the controller, which calls the ''copy_questionnaire_details'' method, which is present in the Questionnaire model. The instructor_id as well as the params are passed as arguments to the ''copy_questionnaire_details'' method.
* The other methods that the older ''copy_questionnaire_details'' methods used to call, like ''assign_instructor_id'' were removed in the changes above and they are now included in the method in the model itself.
* The Exception (if it occurs while saving the Questionnaire object) is being handled in the ''copy'' method of the controller so that the user can be redirected easily.

====Making code DRYer====

=====Problems=====

#There were parts of the code, specifically when QuizQuestionChoice was created, which was copied throughout the questionnaires_controller.rb.

=====Solution=====
* To make the code DRYer, the repeating code sequences were added into a function called ''create_quiz_question_choice''.
* Calls were made to this method wherever QuizQuestionChoice was made.

=== Test Plan ===
There is no means of testing the removal of dead code, except to run the existing suite of test cases:
<pre>
rspec spec
</pre>
Removal of the ''assign_instructor_id'' method can be testing by running test cases for the questionnaires controller:
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>
The logic associated with getting the instructor ID from a user is tested using
<pre>
rspec spec/models/user_spec.rb
</pre>

CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires controller.rb

2019-03-31T13:33:55Z

Jwarren3:

__TOC__

===Description of the project===
The questionnaires controller had several issues; this project aimed to address some of them, including:

* Remove or move logic that should reside elsewhere, e.g. in a model class.
* Remove logic and references to logic that is no longer being used.

===Files modified in the project===
# app/controllers/questionnaires_controller.rb
# app/models/questionnaire.rb
# app/views/questionnaires/_questionnaire.html.erb
# app/views/questionnaires/edit_questionnaire.html.erb (deleted)
# spec/controllers/questionnaires_controller_spec.rb

===Issues and Improvements===

====The ''assign_instructor_id'' method====

=====Problems=====
This method had two issues:
# Its name was misleading because it did not actually assign a value; it simply obtained a value from the user in the session.
# It was delving into implementation details of the ''User'' class.

=====Solution=====
The equivalent logic was already implemented in the ''User'' class's ''instructor_id'' method, so calls to the ''assign_instructor_id'' method were simply replaced with:
<pre>
session[:user].instructor_id
</pre>

A description in ''spec/controllers/questionnaires_controller_spec.rb'' was updated to reflect that ''assign_instructor_id'' was no longer in scope.

====The ''export'' and ''import'' methods====

=====Problems=====
These methods were actually no longer being used, because the functionality they provided was moved to the ''export_file'' and ''import_file'' routes.

=====Solution=====
* The logic was triggered by the presence of the parameters ''import'' or ''export'' in the ''save_all_questions'' action. Code that caused these parameters to be present had been commented out of ''_questionnaire.html.erb'' and ''edit_questionnaire.html.erb'' in the questionnaire views. The latter file was no longer reachable, as there was no reference to an ''edit_questionnaire'' action in ''config/routes.rb'' or any direct references to it in the questionnaires controller itself. Thus the commented-out code was removed from ''_questionnaire.html.erb'' and the ''edit_questionnaire.html.erb'' file was deleted.
* The logic referencing the parameters and methods was removed from the ''save_all_questions'' method.

====The 'copy' and 'copy_questionnaire_details' methods====

=====Problems=====

#There were two methods ''copy'' and ''copy_questionnaire_details'' present in app/controllers/questionnaire_controller.rb which implemented just one functionality of making a copy of a particular questionnaire.
#There was no need of two methods in the controller itself. Also, some parts of what was happening needed to be in the model.

=====Solution=====
* Nothing special was happening in the ''copy_questionnaire_details'' method. Also, it needed to be placed into the model because of the nature of things happening inside it.
* So, now we have one method ''copy'' in the controller, which calls the ''copy_questionnaire_details'' method, which is present in the Questionnaire model. The instructor_id as well as the params are passed as arguments to the ''copy_questionnaire_details'' method.
* The other methods that the older ''copy_questionnaire_details'' methods used to call, like ''assign_instructor_id'' were removed in the changes above and they are now included in the method in the model itself.
* The Exception (if it occurs while saving the Questionnaire object) is being handled in the ''copy'' method of the controller so that the user can be redirected easily.

====Making code DRYer====

=====Problems=====

#There were parts of the code, specifically when QuizQuestionChoice was created, which was copied throughout the questionnaires_controller.rb.

=====Solution=====
* To make the code DRYer, the repeating code sequences were added into a function called ''create_quiz_question_choice''.
* Calls were made to this method wherever QuizQuestionChoice was made.

=== Test Plan ===
There is no means of testing the removal of dead code, except to run the existing suite of test cases:
<pre>
rspec spec
</pre>
Removal of the ''assign_instructor_id'' method can be testing by running test cases for the questionnaires controller:
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires controller.rb

2019-03-24T19:00:00Z

Jwarren3: /* Solution */

CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires controller.rb

2019-03-24T18:57:12Z

Jwarren3: Created page with "__TOC__ ===Description of the project=== The questionnaires controller had several issues; this project aimed to address some of them, including: * Remove or move logic that sh..."

CSC/ECE 517 Spring 2019

2019-03-24T18:24:28Z

Jwarren3: Create initial page for CSC/ECE 517 Spring 2019

* [[CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires_controller.rb]]

MainPage

2019-03-24T18:22:13Z

Jwarren3: Add page for csc517 spring 2019

==Expertiza==
* [[Expertiza documentation]]

* [[CSC/ECE 517 Summer 2008]]
* [[CSC/ECE 517 Fall 2010]]
* [[CSC/ECE 517 Fall 2011]]
* [[CSC/ECE 517 Fall 2012]]
* [[CSC/ECE 517 Fall 2013]]
* [[CSC/ECE 517 Fall 2014]]
* [[CSC/ECE 517 Fall 2015]]
* [[CSC/ECE 517 Fall 2016]]
* [[CSC/ECE 517 Spring 2014]]
* [[CSC/ECE 517 Spring 2015]]
* [[CSC/ECE 517 Spring 2016]]
* [[CSC/ECE 517 Spring 2017]]
* [[CSC/ECE 517 Fall 2017]]
* [[CSC/Independent Study Spring 2018]]
* [[CSC/ECE 517 Spring 2018]]
* [[CSC/ECE 517 Fall 2018]]
* [[CSC/ECE 517 Spring 2019]]
* [[CSC 456 Spring 2011|CSC 456 Spring 2012]]
* [[ECE 633]]
* [[KCU]]
* [[Progress reports]]
* [[ReactJs Frontend]]
==Application Behavior==
* [[Grading]]

==Metaprogramming==
* [[CSC/ECE_517_Spring_2013/ch1b_1k_hf|Lecture on Metaprogramming]]

==Development==

''Expertiza now has a Java dependency, so the machine you are using to develop Expertiza on should have the JVM installed.''

* [[Setting Up a Development Machine]]
* [[Creating a Linux Development Environment for Expertiza - Installation Guide]]
* [[Using git and github for projects]]
* [[Using heroku to deploy your projects]]
* [[How to Begin a Project from the Current Expertiza Repository]]
* [[Git]]
* [[How to Change a User's Password on a Development Machine]]
* [[Debugging Rails]]
* [http://rajanalwan.com/ui_guidelines/ Design Template]

==Production==
* [[Deploying to Production]]
* [[Downloading Production Data]]
* [[Accessing the Production Server]]

==Testing==
* [[Using Cucumber with Expertiza]]
* [[Rails Testing Overview]]
* [[Expertiza Continuous Integration]]

==References==
* [[Object-Oriented Design and Programming]]