Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2026 - E2617. Testing Questionnaire and Course Models

2026-04-14T02:15:40Z

Djhanse2:

== Project Description ==

This project is oriented around the testing of three models representing the individual reviews that each student will be conducting for an assignment. The Questionnaire model represents a review rubric used in assignments. It holds a set of scored questions with configurable min/max score bounds, belongs to an instructor, and supports being copied (along with all its questions and advice) for reuse. It also provides scoring utilities used during assignment evaluation. The QuestionAdvice model represents the score-specific feedback hints attached to a question in a questionnaire (e.g., "if you give a score of 3, here's what that means"). It provides class-level methods to export advice records to CSV and to fetch advice for a given question as JSON. The Course model represents a course in the system. It manages the course's filesystem submission path, handles adding and removing Teaching Assistants (updating their role accordingly via TaMapping), and supports duplicating a course via copy_course. The emphasis is on making sure that the methods associated with the model classes for Questionnaires, QuestionAdvice, and Course are tested using RSpec unit testing and resolving any bugs that are present in the current implementation.

{| class="wikitable"; margin-left:20px; width:320px;"
|-
! colspan="2" style="background:#cee0f2; text-align:center;" | Project Info
|-
| '''Course''' || CSC/ECE 517 Spring 2026
|-
| '''Project''' || E2617 — Testing Questionnaire and Course Models
|-
| '''Instructor''' || Ed Gehringer
|-
| '''Mentor''' || Aanand Sreekumaran Nair Jayakumari
|-
| '''Collaborators''' || DJ Hansen, Zack Brooks, Matt Nguyen
|-
| '''Platform''' || Expertiza (Ruby on Rails)
|-
| '''Test Framework''' || RSpec
|-
| '''Root Class''' || <code>ApplicationRecord</code> (STI superclass)
|-
| '''Subclasses''' || <code>Questionnaire</code>, <code>QuestionAdvice</code>, <code>Course</code>
|-

|}

=== Questionnaire Model ===

==== Questionnaire Attributes ====
* id: '''integer'''
* name: '''string'''
* instructor_id: '''integer'''
* private: '''boolean'''
* min_question_score: '''integer'''
* max_question_score: '''integer'''
* questionnaire_type: '''string'''
* display_type: '''string'''
* instruction_loc: '''text'''
* created_at: '''datetime'''
* updated_at: '''datetime'''

==== Key Relationships ====

* Stores all questions belonging to this questionnaire. Deleting the questionnaire removes its items.
'''has_many :items, foreign_key: "questionnaire_id", dependent: :destroy'''

* Identifies the instructor who owns this questionnaire.
'''belongs_to :instructor

----

=== QuestionAdvice Model ===

==== QuestionAdvice Attributes ====
* id: '''integer'''
* question_id: '''integer'''
* score: '''integer'''
* advice: '''text'''
* created_at: '''datetime'''
* updated_at: '''datetime'''

==== Key Relationships ====

* Links advice to a specific question (item).
'''belongs_to :item'''

----

=== Course Model ===

==== Course Attributes ====
* id: '''integer'''
* name: '''string'''
* directory_path: '''string'''
* info: '''text'''
* private: '''boolean'''
* created_at: '''datetime'''
* updated_at: '''datetime'''
* instructor_id: '''integer'''
* institution_id: '''integer'''

==== Key Relationships ====

* Identifies the instructor responsible for the course.
'''belongs_to :instructor, class_name: 'User', foreign_key: 'instructor_id'''

* Associates the course with an institution.
'''belongs_to :institution, foreign_key: 'institution_id'''

* Stores all assignments in the course; removed when the course is deleted.
'''has_many :assignments, dependent: :destroy'''

* Manages enrolled users through a join table.
'''has_many :participants, class_name: 'CourseParticipant', foreign_key: 'parent_id', dependent: :destroy, inverse_of: :course'''
'''has_many :users, through: :course_participants, inverse_of: :course'''

* Manages teaching assistants for the course.
'''has_many :ta_mappings, dependent: :destroy'''
'''has_many :tas, through: :ta_mappings, source: :ta'''

* Stores teams within the course.
'''has_many :teams, class_name: 'CourseTeam', foreign_key: 'parent_id', dependent: :destroy, inverse_of: :course'''

== Method Description ==
The following section discusses the current implementation of methods that our group will be unit testing.

=== Questionnaire Model Methods ===

==== 1. validate_questionnaire ====
Validates a questionnaire by ensuring:
* Maximum score is a positive integer
* Minimum score is a non-negative integer
* Minimum score is less than the maximum score
* Questionnaire name is unique per instructor

<pre>
def validate_questionnaire
errors.add(:max_question_score, 'The maximum item score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum item score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum item score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end
</pre>

==== 2. self.copy_questionnaire_details ====
Clones a questionnaire, including its items and associated advice.

<pre>
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
items = Item.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.instructor_id = params[:instructor_id]
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.save!

items.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.size = '50,3' if (new_question.is_a?(Criterion) || new_question.is_a?(TextResponse)) && new_question.size.nil?
new_question.save!

advice = QuestionAdvice.where(question_id: question.id)
next if advice.empty?

advice.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

questionnaire
end
</pre>

==== 3. check_for_question_associations ====
Checks whether the questionnaire has associated items before deletion.

<pre>
def check_for_question_associations
if items.any?
raise ActiveRecord::DeleteRestrictionError.new("Cannot delete record because dependent items exist")
end
end
</pre>

==== 4. get_weighted_score ====
Calculates the weighted score by generating a symbol and calling a helper method.

<pre>
def get_weighted_score(assignment, scores)
# create symbol for "varying rubrics" feature -Yang
round = AssignmentQuestionnaire.find_by(assignment_id: assignment.id, questionnaire_id: id).used_in_round

questionnaire_symbol = if round.nil?
symbol
else
(symbol.to_s + round.to_s).to_sym
end

compute_weighted_score(questionnaire_symbol, assignment, scores)
end
</pre>

==== 5. compute_weighted_score ====
Helper method that computes the weighted score for an assignment.

<pre>
def compute_weighted_score(symbol, assignment, scores)
aq = AssignmentQuestionnaire.find_by(assignment_id: assignment.id)

if scores[symbol][:scores][:avg].nil?
0
else
scores[symbol][:scores][:avg] * aq.questionnaire_weight / 100.0
end
end
</pre>

==== 6. true_false_items? ====
Checks if the questionnaire contains any true/false (checkbox) items.

<pre>
def true_false_items?
items.each { |question| return true if question.type == 'Checkbox' }
false
end
</pre>

==== 7. max_possible_score ====
Calculates the maximum possible score based on item weights and max question score.

<pre>
def max_possible_score
results = Questionnaire.joins('INNER JOIN items ON items.questionnaire_id = questionnaires.id')
.select('SUM(items.weight) * questionnaires.max_question_score as max_score')
.where('questionnaires.id = ?', id)
results[0].max_score
end
</pre>

=== QuestionAdvice Model Methods ===

==== 1. self.export_fields ====
Returns all column names of QuestionAdvice as strings.

<pre>
def self.export_fields(_options)
QuestionAdvice.columns.map(&:name)
end
</pre>

==== 2. self.export ====
Exports QuestionAdvice entries to a CSV file.

<pre>
def self.export(csv, parent_id, _options)
questionnaire = Questionnaire.find(parent_id)

questionnaire.items.each do |item|
QuestionAdvice.where(question_id: item.id).each do |advice|
csv << advice.attributes.values
end
end
end
</pre>

==== 3. self.to_json_by_question_id ====
Exports QuestionAdvice entries to JSON format by question ID.

<pre>
def self.to_json_by_question_id(question_id)
question_advices = QuestionAdvice.where(question_id: question_id).order(:id)

question_advices.map do |advice|
{ score: advice.score, advice: advice.advice }
end
end
</pre>

=== Course Model Methods ===

==== 1. path ====
Returns the submission directory path for the course.

<pre>
def path
raise 'Path can not be created as the course must be associated with an instructor.' if instructor_id.nil?

Rails.root + '/' +
Institution.find(institution_id).name.gsub(" ", "") + '/' +
User.find(instructor_id).name.gsub(" ", "") + '/' +
directory_path + '/'
end
</pre>

==== 2. add_ta ====
Adds a Teaching Assistant (TA) to the course.

<pre>
def add_ta(user)
if user.nil?
return { success: false, message: "The user with id #{user.id} does not exist" }

elsif TaMapping.exists?(user_id: user.id, course_id: id)
return { success: false, message: "The user with id #{user.id} is already a TA for this course." }

else
ta_mapping = TaMapping.create(user_id: user.id, course_id: id)
ta_role = Role.find_by(name: 'Teaching Assistant')
user.update(role: ta_role) if ta_role

if ta_mapping.save
return { success: true, data: ta_mapping.slice(:course_id, :user_id) }
else
return { success: false, message: ta_mapping.errors }
end
end
end
</pre>

==== 3. remove_ta ====
Removes a Teaching Assistant from the course.

<pre>
def remove_ta(user_id)
ta_mapping = ta_mappings.find_by(user_id: user_id, course_id: :id)
return { success: false, message: "No TA mapping found for the specified course and TA" } if ta_mapping.nil?

ta = User.find(ta_mapping.user_id)
ta_count = TaMapping.where(user_id: user_id).size - 1

if ta_count.zero?
ta.update(role: Role::STUDENT)
end

ta_mapping.destroy
{ success: true, ta_name: ta.name }
end
</pre>

==== 4. copy_course ====
Creates a duplicate of the course.

<pre>
def copy_course
new_course = dup
new_course.directory_path += '_copy'
new_course.name += '_copy'
new_course.save
end
</pre>

== Issues in Existing Code==

=== Bugs ===
The following statements in the Questionnaire model have inconsistent naming as the first statement relies on the relationship "participants" while the second statement relies on the relationship "course_participants" which doesn't exist.

<pre>
has_many :participants, class_name: 'CourseParticipant', foreign_key: 'parent_id', dependent: :destroy, inverse_of: :course
has_many :users, through: :course_participants, inverse_of: :course
</pre>

=== Coverage Issues ===

spec/models/questionnaire_spec.rb exists but only covers validations, associations, and copy_questionnaire_details. Several instance methods and the entire QuestionAdvice model have less coverage.

spec/models/course_spec.rb only tests validations and the path method. Three instance methods - add_ta, remove_ta, and copy_course - have zero unit test coverage.

== Test Plan ==

For this project, we will be using factories and fixtures to generate our models for unit testing with RSpec.

==== Questionnaire ====

Currently for Questionnaire, the data for unit testing is currently being created using Factory so we will continue to write tests that ensure over 80% code coverage. We will also use factories for the Course model as the method logic is dependent on varying data. It allows us to adjust parameters and test for edge cases easier.

The following code is currently how the factory for the Questionnaire model is set up.

<pre>
# spec/factories/questionnaires.rb
FactoryBot.define do
factory :questionnaire do
sequence(:name) { |n| "Questionnaire #{n}" }
private { false }
min_question_score { 0 }
max_question_score { 10 }
association :instructor
association :assignment

# Trait for questionnaire with questions
trait :with_questions do
after(:create) do |questionnaire|
create(:item, questionnaire: questionnaire, weight: 1, seq: 1, txt: "que 1", question_type: "Scale")
create(:item, questionnaire: questionnaire, weight: 10, seq: 2, txt: "que 2", question_type: "Checkbox")
end
end
end
end
</pre>

The following code serves as the factory for generating instances of items which are essentially questions in a questionnaire object.

<pre>
# spec/factories/items.rb
FactoryBot.define do
factory :item do
sequence(:txt) { |n| "Question #{n}" }
sequence(:seq) { |n| n }
weight { 1 }
question_type { "Scale" }
break_before { true }
association :questionnaire
end
end
</pre>

==== Course ====

The following code is the current version of the factory for the course models.

<pre>
FactoryBot.define do
factory :course do
name { Faker::Educator.course_name }
info { Faker::Lorem.paragraph }
private { false }
directory_path { Faker::File.dir }
association :institution, factory: :institution
association :instructor, factory: :user
end
end
</pre>

==== QuestionAdvice ====

For QuestionAdvice use fixtures to load data into database to test that it is being saved and exported properly. As it stands, there isn't that much logical complexity with the data inside QuestionAdvice itself as it is more concerned with exporting data into csv or json files for storage. The fixtures are stored in question_advice.yml under the fixtures folder.

<pre>
#question_advice.yml

question_advice_1:
id: 1
question_id: 1
score: 5
advice: "This is some advice for question 1."

question_advice_2:
id: 2
question_id: 2
score: 3
advice: "This is some advice for question 2."
</pre>

== Coverage and Current Results ==
SimpleCov report for models under test can be found in the [https://darrinj22.github.io/#_AllFiles Coverage Report].

Test Results:
{| class="wikitable"
! File !! % covered !! Lines !! Relevant Lines !! Lines covered !! Lines missed !! Avg. Hits / Line
|-
| app/models/questionnaire.rb || 64.06% || 141 || 64 || 41 || 23 || 3.02
|-
| app/models/question_advice.rb || 38.46% || 24 || 13 || 5 || 8 || 0.38
|-
| app/models/course.rb || 43.59% || 59 || 39 || 17 || 22 || 0.46
|}

== Conclusion ==
This section will be updated with final results at the end of the project.

== Github ==
Link to Github Project repo: [https://github.com/MATTMINWIN/reimplementation-back-end]

== References ==

CSC/ECE 517 Spring 2026 - E2617. Testing Questionnaire and Course Models

2026-04-14T02:01:16Z

Djhanse2:

== Project Description ==

This project is oriented around the testing of three models representing the individual reviews that each student will be conducting for an assignment. The Questionnaire model represents a review rubric used in assignments. It holds a set of scored questions with configurable min/max score bounds, belongs to an instructor, and supports being copied (along with all its questions and advice) for reuse. It also provides scoring utilities used during assignment evaluation. The QuestionAdvice model represents the score-specific feedback hints attached to a question in a questionnaire (e.g., "if you give a score of 3, here's what that means"). It provides class-level methods to export advice records to CSV and to fetch advice for a given question as JSON. The Course model represents a course in the system. It manages the course's filesystem submission path, handles adding and removing Teaching Assistants (updating their role accordingly via TaMapping), and supports duplicating a course via copy_course. The emphasis is on making sure that the methods associated with the model classes for Questionnaires, QuestionAdvice, and Course are tested using RSpec unit testing and resolving any bugs that are present in the current implementation.

{| class="wikitable"; margin-left:20px; width:320px;"
|-
! colspan="2" style="background:#cee0f2; text-align:center;" | Project Info
|-
| '''Course''' || CSC/ECE 517 Spring 2026
|-
| '''Project''' || E2617 — Testing Questionnaire and Course Models
|-
| '''Instructor''' || Ed Gehringer
|-
| '''Mentor''' || Aanand Sreekumaran Nair Jayakumari
|-
| '''Collaborators''' || DJ Hansen, Zack Brooks, Matt Nguyen
|-
| '''Platform''' || Expertiza (Ruby on Rails)
|-
| '''Test Framework''' || RSpec
|-
| '''Root Class''' || <code>ApplicationRecord</code> (STI superclass)
|-
| '''Subclasses''' || <code>Questionnaire</code>, <code>QuestionAdvice</code>, <code>Course</code>
|-

|}

=== Questionnaire Model ===

==== Questionnaire Attributes ====
* id: '''integer'''
* name: '''string'''
* instructor_id: '''integer'''
* private: '''boolean'''
* min_question_score: '''integer'''
* max_question_score: '''integer'''
* questionnaire_type: '''string'''
* display_type: '''string'''
* instruction_loc: '''text'''
* created_at: '''datetime'''
* updated_at: '''datetime'''

==== Key Relationships ====

* Stores all questions belonging to this questionnaire. Deleting the questionnaire removes its items.
'''has_many :items, foreign_key: "questionnaire_id", dependent: :destroy'''

* Identifies the instructor who owns this questionnaire.
'''belongs_to :instructor

----

=== QuestionAdvice Model ===

==== QuestionAdvice Attributes ====
* id: '''integer'''
* question_id: '''integer'''
* score: '''integer'''
* advice: '''text'''
* created_at: '''datetime'''
* updated_at: '''datetime'''

==== Key Relationships ====

* Links advice to a specific question (item).
'''belongs_to :item'''

----

=== Course Model ===

==== Course Attributes ====
* id: '''integer'''
* name: '''string'''
* directory_path: '''string'''
* info: '''text'''
* private: '''boolean'''
* created_at: '''datetime'''
* updated_at: '''datetime'''
* instructor_id: '''integer'''
* institution_id: '''integer'''

==== Key Relationships ====

* Identifies the instructor responsible for the course.
'''belongs_to :instructor, class_name: 'User', foreign_key: 'instructor_id'''

* Associates the course with an institution.
'''belongs_to :institution, foreign_key: 'institution_id'''

* Stores all assignments in the course; removed when the course is deleted.
'''has_many :assignments, dependent: :destroy'''

* Manages enrolled users through a join table.
'''has_many :participants, class_name: 'CourseParticipant', foreign_key: 'parent_id', dependent: :destroy, inverse_of: :course'''
'''has_many :users, through: :course_participants, inverse_of: :course'''

* Manages teaching assistants for the course.
'''has_many :ta_mappings, dependent: :destroy'''
'''has_many :tas, through: :ta_mappings, source: :ta'''

* Stores teams within the course.
'''has_many :teams, class_name: 'CourseTeam', foreign_key: 'parent_id', dependent: :destroy, inverse_of: :course'''

== Method Description ==
The following section discusses the current implementation of methods that our group will be unit testing.

=== Questionnaire Model Methods ===

==== 1. validate_questionnaire ====
Validates a questionnaire by ensuring:
* Maximum score is a positive integer
* Minimum score is a non-negative integer
* Minimum score is less than the maximum score
* Questionnaire name is unique per instructor

<pre>
def validate_questionnaire
errors.add(:max_question_score, 'The maximum item score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum item score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum item score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end
</pre>

==== 2. self.copy_questionnaire_details ====
Clones a questionnaire, including its items and associated advice.

<pre>
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
items = Item.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.instructor_id = params[:instructor_id]
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.save!

items.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.size = '50,3' if (new_question.is_a?(Criterion) || new_question.is_a?(TextResponse)) && new_question.size.nil?
new_question.save!

advice = QuestionAdvice.where(question_id: question.id)
next if advice.empty?

advice.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

questionnaire
end
</pre>

==== 3. check_for_question_associations ====
Checks whether the questionnaire has associated items before deletion.

<pre>
def check_for_question_associations
if items.any?
raise ActiveRecord::DeleteRestrictionError.new("Cannot delete record because dependent items exist")
end
end
</pre>

==== 4. get_weighted_score ====
Calculates the weighted score by generating a symbol and calling a helper method.

<pre>
def get_weighted_score(assignment, scores)
# create symbol for "varying rubrics" feature -Yang
round = AssignmentQuestionnaire.find_by(assignment_id: assignment.id, questionnaire_id: id).used_in_round

questionnaire_symbol = if round.nil?
symbol
else
(symbol.to_s + round.to_s).to_sym
end

compute_weighted_score(questionnaire_symbol, assignment, scores)
end
</pre>

==== 5. compute_weighted_score ====
Helper method that computes the weighted score for an assignment.

<pre>
def compute_weighted_score(symbol, assignment, scores)
aq = AssignmentQuestionnaire.find_by(assignment_id: assignment.id)

if scores[symbol][:scores][:avg].nil?
0
else
scores[symbol][:scores][:avg] * aq.questionnaire_weight / 100.0
end
end
</pre>

==== 6. true_false_items? ====
Checks if the questionnaire contains any true/false (checkbox) items.

<pre>
def true_false_items?
items.each { |question| return true if question.type == 'Checkbox' }
false
end
</pre>

==== 7. max_possible_score ====
Calculates the maximum possible score based on item weights and max question score.

<pre>
def max_possible_score
results = Questionnaire.joins('INNER JOIN items ON items.questionnaire_id = questionnaires.id')
.select('SUM(items.weight) * questionnaires.max_question_score as max_score')
.where('questionnaires.id = ?', id)
results[0].max_score
end
</pre>

=== QuestionAdvice Model Methods ===

==== 1. self.export_fields ====
Returns all column names of QuestionAdvice as strings.

<pre>
def self.export_fields(_options)
QuestionAdvice.columns.map(&:name)
end
</pre>

==== 2. self.export ====
Exports QuestionAdvice entries to a CSV file.

<pre>
def self.export(csv, parent_id, _options)
questionnaire = Questionnaire.find(parent_id)

questionnaire.items.each do |item|
QuestionAdvice.where(question_id: item.id).each do |advice|
csv << advice.attributes.values
end
end
end
</pre>

==== 3. self.to_json_by_question_id ====
Exports QuestionAdvice entries to JSON format by question ID.

<pre>
def self.to_json_by_question_id(question_id)
question_advices = QuestionAdvice.where(question_id: question_id).order(:id)

question_advices.map do |advice|
{ score: advice.score, advice: advice.advice }
end
end
</pre>

=== Course Model Methods ===

==== 1. path ====
Returns the submission directory path for the course.

<pre>
def path
raise 'Path can not be created as the course must be associated with an instructor.' if instructor_id.nil?

Rails.root + '/' +
Institution.find(institution_id).name.gsub(" ", "") + '/' +
User.find(instructor_id).name.gsub(" ", "") + '/' +
directory_path + '/'
end
</pre>

==== 2. add_ta ====
Adds a Teaching Assistant (TA) to the course.

<pre>
def add_ta(user)
if user.nil?
return { success: false, message: "The user with id #{user.id} does not exist" }

elsif TaMapping.exists?(user_id: user.id, course_id: id)
return { success: false, message: "The user with id #{user.id} is already a TA for this course." }

else
ta_mapping = TaMapping.create(user_id: user.id, course_id: id)
ta_role = Role.find_by(name: 'Teaching Assistant')
user.update(role: ta_role) if ta_role

if ta_mapping.save
return { success: true, data: ta_mapping.slice(:course_id, :user_id) }
else
return { success: false, message: ta_mapping.errors }
end
end
end
</pre>

==== 3. remove_ta ====
Removes a Teaching Assistant from the course.

<pre>
def remove_ta(user_id)
ta_mapping = ta_mappings.find_by(user_id: user_id, course_id: :id)
return { success: false, message: "No TA mapping found for the specified course and TA" } if ta_mapping.nil?

ta = User.find(ta_mapping.user_id)
ta_count = TaMapping.where(user_id: user_id).size - 1

if ta_count.zero?
ta.update(role: Role::STUDENT)
end

ta_mapping.destroy
{ success: true, ta_name: ta.name }
end
</pre>

==== 4. copy_course ====
Creates a duplicate of the course.

<pre>
def copy_course
new_course = dup
new_course.directory_path += '_copy'
new_course.name += '_copy'
new_course.save
end
</pre>

== Issues in Existing Code==

=== Bugs ===
The following statements in the Questionnaire model have inconsistent naming as the first statement relies on the relationship "participants" while the second statement relies on the relationship "course_participants" which doesn't exist.

<pre>
has_many :participants, class_name: 'CourseParticipant', foreign_key: 'parent_id', dependent: :destroy, inverse_of: :course
has_many :users, through: :course_participants, inverse_of: :course
</pre>

=== Coverage Issues ===

spec/models/questionnaire_spec.rb exists but only covers validations, associations, and copy_questionnaire_details. Several instance methods and the entire QuestionAdvice model have less coverage.

spec/models/course_spec.rb only tests validations and the path method. Three instance methods - add_ta, remove_ta, and copy_course - have zero unit test coverage.

== Test Plan ==

For this project, we will be using factories and fixtures to generate our models for unit testing with RSpec.

==== Questionnaire ====

Currently for Questionnaire, the data for unit testing is currently being created using Factory so we will continue to write tests that ensure over 80% code coverage. We will also use factories for the Course model as the method logic is dependent on varying data. It allows us to adjust parameters and test for edge cases easier.

The following code is currently how the factory for the Questionnaire model is set up.

<pre>
# spec/factories/questionnaires.rb
FactoryBot.define do
factory :questionnaire do
sequence(:name) { |n| "Questionnaire #{n}" }
private { false }
min_question_score { 0 }
max_question_score { 10 }
association :instructor
association :assignment

# Trait for questionnaire with questions
trait :with_questions do
after(:create) do |questionnaire|
create(:item, questionnaire: questionnaire, weight: 1, seq: 1, txt: "que 1", question_type: "Scale")
create(:item, questionnaire: questionnaire, weight: 10, seq: 2, txt: "que 2", question_type: "Checkbox")
end
end
end
end
</pre>

The following code serves as the factory for generating instances of items which are essentially questions in a questionnaire object.

<pre>
# spec/factories/items.rb
FactoryBot.define do
factory :item do
sequence(:txt) { |n| "Question #{n}" }
sequence(:seq) { |n| n }
weight { 1 }
question_type { "Scale" }
break_before { true }
association :questionnaire
end
end
</pre>

==== Course ====

The following code is the current version of the factory for the course models.

<pre>
FactoryBot.define do
factory :course do
name { Faker::Educator.course_name }
info { Faker::Lorem.paragraph }
private { false }
directory_path { Faker::File.dir }
association :institution, factory: :institution
association :instructor, factory: :user
end
end
</pre>

==== QuestionAdvice ====

For QuestionAdvice use fixtures to load data into database to test that it is being saved and exported properly. As it stands, there isn't that much logical complexity with the data inside QuestionAdvice itself as it is more concerned with exporting data into csv or json files for storage. The fixtures are stored in question_advice.yml under the fixtures folder.

<pre>
#question_advice.yml

question_advice_1:
id: 1
question_id: 1
score: 5
advice: "This is some advice for question 1."

question_advice_2:
id: 2
question_id: 2
score: 3
advice: "This is some advice for question 2."
</pre>

== Coverage and Current Results ==
SimpleCov report for models under test can be found here.

Test Results:
{| class="wikitable"
! File !! % covered !! Lines !! Relevant Lines !! Lines covered !! Lines missed !! Avg. Hits / Line
|-
| app/models/questionnaire.rb || 64.06% || 141 || 64 || 41 || 23 || 3.02
|-
| app/models/question_advice.rb || 38.46% || 24 || 13 || 5 || 8 || 0.38
|-
| app/models/course.rb || 43.59% || 59 || 39 || 17 || 22 || 0.46
|}

== Conclusion ==
This section will be updated with final results at the end of the project.

== Github ==
Link to Github Project repo: [https://github.com/MATTMINWIN/reimplementation-back-end]

== References ==