feat: continue to incorporate feedback feature stage, criterion, crit…

…erion_option, feedback_comment, and feedback_comment_template.

app/api/entities/feedback_entities/feedback_comment_entity.rb

@@ -0,0 +1,6 @@
+module Entities
+  class FeedbackCommentEntity < Grape::Entity
+    expose :id
+    expose :comment
+  end
+end

app/api/entities/feedback_entities/feedback_comment_template_entity.rb

@@ -0,0 +1,7 @@
+module Entities
+  class FeedbackCommentTemplateEntity < Grape::Entity
+    expose :id
+    expose :comment_text_situation
+    expose :comment_text_next_action
+  end
+end

app/models/feedback/criterion.rb

@@ -4,7 +4,7 @@ class Criterion < ApplicationRecord
   has_many :criterion_options, dependent: :destroy
 
   # Constraints
-  # validates_associated :stage
+  validates_associated :stage
   validates :order, :description, presence: true
   validates :order, numericality: {
     greater_than_or_equal_to: 0, only_integer: true,

app/models/feedback/criterion_option.rb

@@ -4,4 +4,7 @@ class CriterionOption < ApplicationRecord
   belongs_to :task_status
   has_many :feedback_comment_templates
   has_many :feedback_comments
+
+  # Constraints
+  validates_associated :criterion
 end

app/models/feedback/feedback_comment.rb

@@ -3,5 +3,5 @@ class FeedbackComment < TaskComment
   belongs_to :criterion_option
 
   # Constraints
-  validates :comment_text, presence: true
+  validates :comment, presence: true
 end

app/models/feedback/feedback_comment_template.rb

@@ -1,6 +1,5 @@
 class FeedbackCommentTemplate < ApplicationRecord
   # Associations
-  # belongs_to :stage -- other direction
   belongs_to :criterion_option
 
   # Constraints

app/models/feedback/stage.rb

@@ -2,7 +2,6 @@ class Stage < ApplicationRecord
   # Associations
   belongs_to :task_definition
   has_many :criteria, dependent: :destroy
-  has_many :feedback_comment_templates
   has_one :unit, through: :task_definition
 
   # Constraints

app/models/task_status.rb

@@ -6,6 +6,7 @@ class TaskStatus < ApplicationRecord
 
   # Model associations
   has_many :tasks
+  has_many :criterion_options
 
   #
   # Override find to ensure that task status objects are cached - these do not change

db/migrate/20221215042412_add_tables_for_feedback_enhancement.rb

@@ -11,7 +11,6 @@ def change
 
       # Foreign keys
       t.references :task_definition
-      t.references :feedback_comment_template
     end
 
     create_table :criteria do |t| # "criteria" is set as plural of "criterion" in 'doubtfire-api/config/initializers/inflections.rb'

db/schema.rb

@@ -229,8 +229,6 @@
     t.string "exit_message_good"
     t.string "exit_message_resubmit"
     t.bigint "task_definition_id"
-    t.bigint "feedback_comment_template_id"
-    t.index ["feedback_comment_template_id"], name: "index_stages_on_feedback_comment_template_id"
     t.index ["task_definition_id"], name: "index_stages_on_task_definition_id"
   end
 

test/factories/feedback/criterion_factory.rb

@@ -0,0 +1,18 @@
+
+FactoryBot.define do
+    factory :criterion do
+        transient do
+            number_of_criterion_options {0}
+        end
+
+        stage
+
+        sequence(:order)            { |n| n }
+        description                 { Faker::Lorem.sentence }
+        help_text                   { Faker::Lorem.sentence }
+
+        after(:create) do |criterion, evaluator|
+            create_list(:criterion_option, evaluator.number_of_criterion_options, criterion: criterion)
+        end
+    end
+end

test/factories/feedback/criterion_option_factory.rb

@@ -0,0 +1,19 @@
+
+FactoryBot.define do
+    factory :criterion_option do
+        transient do
+            number_of_feedback_comment_templates {0}
+        end
+
+        association :criterion # associates according to relationship within models
+        task_status                  { TaskStatus.all.sample }
+
+        # outcome_status
+        resolved_message_text        { Faker::Lorem.sentence }
+        unresolved_message_text      { Faker::Lorem.sentence }
+
+        after(:create) do |criterion_option, evaluator|
+            create_list(:feedback_comment_template, evaluator.number_of_feedback_comment_templates, criterion_option: criterion_option)
+        end
+    end
+end

test/factories/feedback/feedback_comment_factory.rb

@@ -0,0 +1,8 @@
+
+FactoryBot.define do
+    factory :feedback_comment do
+
+        association :feedback_comment_template
+        association :criterion_option
+    end
+end

test/factories/feedback/feedback_comment_template_factory.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+    factory :feedback_comment_template do
+      criterion_option
+
+      comment_text_situation    { Faker::Lorem.sentence }
+      comment_text_next_action  { Faker::Lorem.sentence }
+    end
+end

test/factories/feedback/stage_factory.rb

@@ -1,24 +1,25 @@
 # Read about factories at https://github.com/thoughtbot/factory_bot
 
 FactoryBot.define do
+
   factory :stage do
-    transient do
-      number_of_criterion {0}
-    end
 
-    task_definition
+    association :task_definition
+
+    transient do # transient: not persisted to database
+      number_of_criterion {0} # `0` criteria created unless otherwise specified
+      # E.g., "FactoryBot.create(:stage, number_of_criterion: 3)"
+    end
 
     sequence(:order)          { |n| n }
     sequence(:title)          { |n| "Stage-#{n}" }
-
     help_text                 { Faker::Lorem.sentence }
     entry_message             { Faker::Lorem.sentence }
     exit_message_good         { Faker::Lorem.sentence }
     exit_message_resubmit     { Faker::Lorem.sentence }
 
-    after(:build) do |stage, eval|
-      # Create a list of criterion that refer to the created stage
-      create_list(:criteria, eval.number_of_criterion, stage: stage)
+    after(:create) do |stage, evaluator|
+      create_list(:criteria, evaluator.number_of_criterion, stage: stage)
     end
   end
 end

test/models/feedback/criterion_model_test.rb

@@ -4,15 +4,15 @@
 # Tests for Criterion model objects - not accessed via API
 #
 class CriterionModelTest < ActiveSupport::TestCase
-    def app
-        Rails.application
+
+    setup do
+        DatabaseCleaner.start
+        @stage = FactoryBot.create(:stage)
     end
 
     # Test you can create a valid criterion
-    def test_criterion_creation
-        td = FactoryBot.create(:task_definition)
-        stage = Stage.create(task_definition: td, title: 'Stage 1', order: 1)
-        criterion = Criterion.create(stage: stage, description: 'Criterion 1', order: 1)
+    def test_valid_criterion_creation
+        criterion = Criterion.create(stage: @stage, description: 'Criterion 1', order: 1)
 
         assert criterion
         assert criterion.stage
@@ -22,17 +22,20 @@ def test_criterion_creation
 
     # Test you cannot create an invalid criterion
     def test_criterion_order_and_description_are_required
-        stage = FactoryBot.create(:stage)
-        criterion = Criterion.new(stage: stage)
+        # stage = FactoryBot.create(:stage)
+        criterion = Criterion.create(stage: @stage)
 
-        refute criterion.valid? # "refute": fail if true
+        refute criterion.valid? # "refute": fail if true, pass if false
         # Validator is included in criterion model (@ doubtfire-api/app/models/feedback/criterion.rb)
         criterion.description = 'Criterion 1'
-        refute criterion.valid?
+        refute criterion.valid? # still shoul not be valid until order is added
         criterion.order = 1
         assert criterion.valid?
         criterion.description = nil
         refute criterion.valid?
+        criterion.description = 'Criterion'
+        criterion.order = nil
+        refute criterion.valid?
 
         refute criterion.save # fail if criterion is saved
     end

test/models/feedback/criterion_option_model_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+#
+# Tests for CriterionOption model objects - not accessed via API
+#
+class CriterionOptionModelTest < ActiveSupport::TestCase
+
+    # Setup objects for testing
+    setup do
+        DatabaseCleaner.start
+        @criterion = FactoryBot.create(:criterion)
+        @task_status = TaskStatus.new
+    end
+
+    # Test you can create a valid criterion option
+    def test_valid_criterion_option_creation
+        criterion_option = CriterionOption.create(criterion: @criterion, task_status: @task_status)
+        assert criterion_option.valid?
+        criterion_option.resolved_message_text = Faker::Lorem.sentence
+        assert criterion_option.valid?
+        criterion_option.unresolved_message_text = Faker::Lorem.sentence
+        assert criterion_option.valid?
+    end
+
+    # Test you cannot create an invalid criterion option
+    def test_invalid_criterion_option_creation
+        criterion_option = CriterionOption.new
+
+        refute criterion_option.valid?
+        criterion_option.resolved_message_text = Faker::Lorem.sentence
+        refute criterion_option.valid?
+        criterion_option.unresolved_message_text = Faker::Lorem.sentence
+        refute criterion_option.valid?
+
+        criterion_option.task_status = @task_status
+        refute criterion_option.valid?
+        criterion_option.criterion = @criterion
+        assert criterion_option.valid?
+        criterion_option.task_status = nil
+        refute criterion_option.valid?
+
+        refute criterion_option.save
+    end
+end

test/models/feedback/feedback_comment_model_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+#
+# Contains tests for FeedbackComment model objects - not accessed via API
+#
+class FeedbackCommentModelTest < ActiveSupport::TestCase
+
+    # Setup objects for testing
+    def setup
+        DatabaseCleaner.start
+        criterion = FactoryBot.create(:criterion)
+        task_status = TaskStatus.new
+        @criterion_option = CriterionOption.create(criterion: criterion, task_status: task_status)
+
+        @task = Task.new
+        @user = FactoryBot.create(:user)
+        @recipient = FactoryBot.create(:user)
+    end
+
+    # Test the creation of a valid feedback comment
+    def test_valid_feedback_comment_creation
+        feedback_comment = FeedbackComment.new(task: @task, user: @user, recipient: @recipient, comment: 'Test Comment', criterion_option: @criterion_option)
+        assert feedback_comment.valid?
+    end
+
+    # Test the creation of an invalid feedback comment
+    def test_invalid_feedback_comment_creation
+        feedback_comment = FeedbackComment.new
+        refute feedback_comment.valid?
+
+        feedback_comment.task = @task
+        refute feedback_comment.valid?
+
+        feedback_comment.user = @user
+        refute feedback_comment.valid?
+
+        feedback_comment.recipient = @recipient
+        refute feedback_comment.valid?
+
+        feedback_comment.comment = 'Test Comment'
+        refute feedback_comment.valid?
+
+        feedback_comment.criterion_option = @criterion_option
+        assert feedback_comment.valid?
+
+        feedback_comment.task = nil
+        refute feedback_comment.valid?
+
+        feedback_comment.task = @task
+        feedback_comment.user = nil
+
+        refute feedback_comment.save
+    end
+end

test/models/feedback/feedback_comment_template_model_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+#
+# Contains tests for FeedbackCommentTemplate model objects - not accessed via API
+# 
+class FeedbackCommentTemplateModelTest < ActiveSupport::TestCase
+
+    # Setup objects for testing
+    def setup
+        DatabaseCleaner.start
+        task_status = TaskStatus.new
+        @criterion_option = CriterionOption.create(task_status: task_status)
+    end
+
+    # Test you can create a valid feedback comment template
+    def test_valid_feedback_comment_template_creation
+        feedback_comment_template = FeedbackCommentTemplate.create(criterion_option: @criterion_option, comment_text_situation: 'This is the situation')
+
+        assert feedback_comment_template.valid?
+
+        assert feedback_comment_template.criterion_option == @criterion_option
+        assert feedback_comment_template.comment_text_situation == 'This is the situation'
+    end
+
+    # Test you cannot create an invalid feedback comment template
+    def test_invalid_feedback_comment_template_creation
+        feedback_comment_template = FeedbackCommentTemplate.new
+        refute feedback_comment_template.valid?
+
+        feedback_comment_template.comment_text_situation = 'This is a comment'
+        refute feedback_comment_template.valid?
+
+        feedback_comment_template.criterion_option = @criterion_option
+        assert feedback_comment_template.valid?
+
+        feedback_comment_template.comment_text_situation = nil
+        refute feedback_comment_template.valid?
+
+        refute feedback_comment_template.save
+    end
+end