1
            

            

            class AdviceController < ApplicationController
          
        
      
        

          

            1
            

            

              before_action :set_questionnaire, only: %i[ edit_advice save_advice ]
          
        
      
        

          

            
            

            

              # Advice_controller first checks whether current user has TA privileges or not by implementing action_allowed? method. Secondly it sets the number of advices based on score and sort it in descending order. Then it checks four conditions for the advices.
          
        
      
        

          

            
            

            

              # 1. If number of advices is not equal to given advices
          
        
      
        

          

            
            

            

              # 2. If the sorted advices is empty
          
        
      
        

          

            
            

            

              # 3. If first advice score of sorted advices is NOT equal to max score
          
        
      
        

          

            
            

            

              # 4. If last advice score of sorted advices is NOT equal to min score
          
        
      
        

          

            
            

            

              # If any of the above condition are True, the edit_advice method calls adjust_advice_size of the QuestionnaireHelper class which adjust the advice sizes accordingly.
          
        
      
        

          

            
            

            

              # In the end, save_advice method is called which updates and saves the changes in the advices and displays the success/failure message.
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            1
            

            

              include AuthorizationHelper
          
        
      
        

          

            
            

            

              # If current user is TA then only current user can edit and update the advice
          
        
      
        

          

            1
            

            

              def action_allowed?
          
        
      
        

          

            
            

            

                current_user_has_ta_privileges?
          
        
      
        

          

            
            

            

              end
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

              ## This method will return true if the advice and its scores is invalid.
          
        
      
        

          

            
            

            

              # Validates by utilizing the private methods invalid_advice_length? and invalid_advice_scores?
          
        
      
        

          

            1
            

            

              def invalid_advice?(sorted_advice, num_advices, question)
          
        
      
        

          

            12
            

            

                invalid_advice_length?(num_advices, question, sorted_advice) ||
          
        
      
        

          

            
            

            

                  invalid_advice_scores?(sorted_advice)
          
        
      
        

          

            
            

            

              end
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

              # Modify the advice associated with a questionnaire
          
        
      
        

          

            
            

            

              # Separate methods were introduced to calculate the number of advices and sort the advices related to the current question attribute
          
        
      
        

          

            
            

            

              # This is done to adhere to Single Responsibility Principle
          
        
      
        

          

            1
            

            

              def edit_advice
          
        
      
        

          

            
            

            

                # For each question in a questionnaire, this method adjusts the advice size if the advice size is <,> number of advices or
          
        
      
        

          

            
            

            

                # the max or min score of the advices does not correspond to the max or min score of questionnaire respectively.
          
        
      
        

          

            12
            

            

                @questionnaire.questions.each do |question|
          
        
      
        

          

            
            

            

                  # if the question is a scored question, store the number of advices corresponding to that question (max_score - min_score), else 0
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            12
            

            

                  num_advices = calculate_num_advices(question)
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

                  # sorting question advices in descending order by score
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            12
            

            

                  sorted_advice = sort_question_advices(question)
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

                  # Checks the condition for adjusting the advice size
          
        
      
        

          

            12
            

            

                  if invalid_advice?(sorted_advice, num_advices, question)
          
        
      
        

          

            
            

            

                    # The number of advices for this question has changed.
          
        
      
        

          

            6
            

            

                    QuestionnaireHelper.adjust_advice_size(@questionnaire, question)
          
        
      
        

          

            
            

            

                  end
          
        
      
        

          

            
            

            

                end
          
        
      
        

          

            
            

            

              end
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

              # save the advice for a questionnaire
          
        
      
        

          

            1
            

            

              def save_advice
          
        
      
        

          

            
            

            

                begin
          
        
      
        

          

            
            

            

                  # checks if advice is present or not
          
        
      
        

          

            4
            

            

                  unless params[:advice].nil?
          
        
      
        

          

            3
            

            

                    params[:advice].each do |advice_key, advice_params|
          
        
      
        

          

            
            

            

                      # get existing advice to update by key with the passed in advice param
          
        
      
        

          

            6
            

            

                      QuestionAdvice.update(advice_key, advice: advice_params.slice(:advice)[:advice])
          
        
      
        

          

            
            

            

                    end
          
        
      
        

          

            
            

            

                    # we made it here so it was saved
          
        
      
        

          

            3
            

            

                    flash[:notice] = 'The advice was successfully saved!'
          
        
      
        

          

            
            

            

                  end
          
        
      
        

          

            
            

            

                rescue ActiveRecord::RecordNotFound
          
        
      
        

          

            
            

            

                  # If record not found, redirects to edit_advice and sends flash
          
        
      
        

          

            
            

            

                  flash[:notice] = 'The advice record was not found and saved!'
          
        
      
        

          

            
            

            

                end
          
        
      
        

          

            
            

            

                # regardless of action above redirect to edit and show flash message if one exists
          
        
      
        

          

            4
            

            

                redirect_to action: 'edit_advice', id: params[:id]
          
        
      
        

          

            
            

            

              end
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            1
            

            

              private
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

              # Common code for set questionnaire
          
        
      
        

          

            1
            

            

              def set_questionnaire
          
        
      
        

          

            
            

            

                # Stores the questionnaire with given id in URL
          
        
      
        

          

            16
            

            

                @questionnaire = Questionnaire.find(params[:id])
          
        
      
        

          

            
            

            

                end
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

              ## Checks to see if the advice is the correct length.
          
        
      
        

          

            
            

            

              #  Checks to see if the number of advices is different than the question_advices or advice is empty
          
        
      
        

          

            1
            

            

              def invalid_advice_length?(num_advices, question, sorted_advice)
          
        
      
        

          

            12
            

            

                question.question_advices.length != num_advices ||
          
        
      
        

          

            
            

            

                  sorted_advice.empty?
          
        
      
        

          

            
            

            

              end
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

              ## Checks to see if the scores are valid
          
        
      
        

          

            
            

            

              # Checks to see if the first and last index of the sorted_advice array are different than expected.
          
        
      
        

          

            1
            

            

              def invalid_advice_scores?(sorted_advice)
          
        
      
        

          

            6
            

            

                sorted_advice[0].score != @questionnaire.max_question_score ||
          
        
      
        

          

            
            

            

                  sorted_advice[sorted_advice.length - 1].score != @questionnaire.min_question_score
          
        
      
        

          

            
            

            

              end
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

              # Function to calculate number of advices for the current question attribute based on max and min question score.
          
        
      
        

          

            
            

            

              # Method name is consistent with the functionality
          
        
      
        

          

            
            

            

              # Refactored the 'if' statement into a ternary operator. This accomplishes the same logic in a more concise manner.
          
        
      
        

          

            1
            

            

              def calculate_num_advices(question)
          
        
      
        

          

            8
            

            

                question.is_a?(ScoredQuestion) ? @questionnaire.max_question_score - @questionnaire.min_question_score + 1 : 0
          
        
      
        

          

            
            

            

              end
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

              # Function to sort question advices related to the current question attribute
          
        
      
        

          

            
            

            

              # While sorting questions, sort_by(&:score) is used instead of using a block. It is a shorthand notation and avoids creating a new Proc object for every element in the collection of the questions.
          
        
      
        

          

            1
            

            

              def sort_question_advices(question)
          
        
      
        

          

            10
            

            

                question.question_advices.sort_by(&:score).reverse
          
        
      
        

          

            
            

            

              end
          
        
      
        

          

            
            

            

            
          
        
      
        

          

            
            

            

            end