Spring2019 E1907 refactor response controller: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
=='''Introduction'''==
='''Introduction'''=
Expertiza is an open source webapp that was built on Ruby on Rails stack. It provides a platform to students with various features like peer-reviewing projects, submitting work, form teams, viewing grades, etc. The project is maintained by students and faculty at NCSU.
Expertiza is an open source webapp that was built on Ruby on Rails stack. It provides a platform to students with various features like peer-reviewing projects, submitting work, form teams, viewing grades, etc. The project is maintained by students and faculty at NCSU.


=='''Project Summary'''==
='''Project Summary'''=
The file response_controller.rb handles the operations on responses based on user permissions.  The user is redirected to the appropriate place on Expertiza after the action is complete. The responses are from the completion of peer reviews and questionnaires. The controller takes care of tasks such as creating, saving, editing, updating and deleting these responses.
The file response_controller.rb handles the operations on responses based on user permissions.  The user is redirected to the appropriate place on Expertiza after the action is complete. The responses are from the completion of peer reviews and questionnaires. The controller takes care of tasks such as creating, saving, editing, updating and deleting these responses.




=='''Tasks accomplished'''==
='''Project Tasks'''=


1. Renamed edit_allowed function to view_allowed in the response_controller.rb file
==Task 1==
'''Problem:'''


Renamed edit_allowed function to view_allowed in the response_controller.rb file


2. Moved the pending_surveys function to survey_deployment_controller.rb
 
'''Solution:'''
 
==Task 2==
'''Problem:'''
 
Moved the pending_surveys function to survey_deployment_controller.rb
 
 
'''Solution:'''


Made changes in the following files and folders:
Made changes in the following files and folders:
Line 20: Line 31:
* Moved pending_surveys.html.erb from views/response to views/survey_deployment
* Moved pending_surveys.html.erb from views/response to views/survey_deployment


==Task 3==
'''Problem:'''


3. Removed assign_instance_vars section as it was not needed and combined in Edit and New sections
3. Removed assign_instance_vars section as it was not needed and combined in Edit and New sections
'''Solution:'''


Original assign_instance_vars method :-
Original assign_instance_vars method :-
Line 101: Line 117:
</pre>
</pre>


4. Removed was_submitted.  Changed to previously_submitted in the in create method.
==Task 4==
'''Problem:'''
 
Removed was_submitted.  Changed to previously_submitted in the create method.
 
'''Solution:'''
 
 
==Task 5==
'''Problem:'''
 
Added comments in private methods
 
 
'''Solution:'''
 
 
==Task 6==
'''Problem:'''


Introduced temporary explaining variables in the redirect method


5. Added comments in private methods


'''Solution:'''


6. Introduced temporary explaining variables in the redirect method


==Test Plan==
='''Test Plan'''=
Because of moving the pending_surveys method, some of the original spec tests failed. So we fixed it.
Because of moving the pending_surveys method, some of the original spec tests failed. So we fixed it.


Line 128: Line 162:
     end
     end


=='''Code Climate and Travis CI '''==
='''Code Climate and Travis CI'''=
There are only cyclomatic , cognitive errors with code climate whereas there are no integration errors with Travis CI
There are only cyclomatic, cognitive errors with code climate whereas there are no integration errors with Travis CI


=='''References'''==
='''References'''=


1. The pull request for this task can be viewed at: https://github.com/expertiza/expertiza/pull/1383
1. The pull request for this task can be viewed at: https://github.com/expertiza/expertiza/pull/1383


2. GitHub Repo:   
2. GitHub Repo:   
https://github.com/Anusha-Godavarthi/expertiza
https://github.com/Anusha-Godavarthi/expertiza


3. Team Branches:  
3. Team Branches:  
https://github.com/Anusha-Godavarthi/expertiza/branches
https://github.com/Anusha-Godavarthi/expertiza/branches


Line 146: Line 180:
5. Expertiza Documentation http://wiki.expertiza.ncsu.edu/index.php/Main_Page
5. Expertiza Documentation http://wiki.expertiza.ncsu.edu/index.php/Main_Page


=='''Team Members'''==
='''Team Members'''=
1.  Anusha Godavarithi
1.  Anusha Godavarithi



Revision as of 01:12, 30 March 2019

Introduction

Expertiza is an open source webapp that was built on Ruby on Rails stack. It provides a platform to students with various features like peer-reviewing projects, submitting work, form teams, viewing grades, etc. The project is maintained by students and faculty at NCSU.

Project Summary

The file response_controller.rb handles the operations on responses based on user permissions. The user is redirected to the appropriate place on Expertiza after the action is complete. The responses are from the completion of peer reviews and questionnaires. The controller takes care of tasks such as creating, saving, editing, updating and deleting these responses.


Project Tasks

Task 1

Problem:

Renamed edit_allowed function to view_allowed in the response_controller.rb file


Solution:

Task 2

Problem:

Moved the pending_surveys function to survey_deployment_controller.rb


Solution:

Made changes in the following files and folders:

  • app/controllers/response_controller.rb
  • app/controllers/survey_deployment_controller.rb
  • config/routes.rb
  • spec/controllers/respose_controller_spec.rb
  • Moved pending_surveys.html.erb from views/response to views/survey_deployment

Task 3

Problem:

3. Removed assign_instance_vars section as it was not needed and combined in Edit and New sections


Solution:

Original assign_instance_vars method :-


def assign_instance_vars
    case params[:action]
    when 'edit'
      @header = 'Edit'
      @next_action = 'update'
      @response = Response.find(params[:id])
      @map = @response.map
      @contributor = @map.contributor
    when 'new'
      @header = 'New'
      @next_action = 'create'
      @feedback = params[:feedback]
      @map = ResponseMap.find(params[:id])
      @modified_object = @map.id
    end
    @return = params[:return]
  end


Moved the assign_instance_vars for the Edit action to the edit method.

  def edit
    # instance variables for Edit action
    @header = 'Edit'
    @next_action = 'update'
    @response = Response.find(params[:id])
    @map = @response.map
    @contributor = @map.contributor
    @prev = Response.where(map_id: @map.id)
    @review_scores = @prev.to_a
    if @prev.present?
      @sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i && m2.version_num.to_i ? m2.version_num.to_i <=>  
m1.version_num.to_i : (m1.version_num ? -1 : 1) }
      @largest_version_num = @sorted[0]
    end
    @modified_object = @response.response_id
    # set more handy variables for the view
    set_content
    @review_scores = []
    @questions.each do |question|
      @review_scores << Answer.where(response_id: @response.response_id, <br> question_id: question.id).first
    end
    @questionnaire = set_questionnaire
    render action: 'response'
  end

Moved assign_instance_vars for the New action inside the new method : -


def new
    # instance variable for New action
    @header = 'New'
    @next_action = 'create'
    @feedback = params[:feedback]
    @map = ResponseMap.find(params[:id])
    @modified_object = @map.id
    set_content(true)
    @stage = @assignment.get_current_stage(SignedUpTeam.topic_id(@participant.parent_id, @participant.user_id)) if @assignment
      team = AssignmentTeam.find(@map.reviewee_id)
    @response = Response.where(map_id: @map.id, round: @current_round.to_i).order(updated_at: :desc).first
    if @response.nil? || team.most_recent_submission.updated_at > @response.updated_at
      @response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)
    end
    questions = sort_questions(@questionnaire.questions)
    init_answers(questions)
    render action: 'response'
  end

Task 4

Problem:

Removed was_submitted. Changed to previously_submitted in the create method.

Solution:


Task 5

Problem:

Added comments in private methods


Solution:


Task 6

Problem:

Introduced temporary explaining variables in the redirect method


Solution:


Test Plan

Because of moving the pending_surveys method, some of the original spec tests failed. So we fixed it.

context 'when params[:return] is survey' do
     it 'redirects to survey_deployment#pending_surveys page' do
       @params[:return] = 'survey'
       get :redirect, @params
       expect(response).to redirect_to('/survey_deployment/pending_surveys')
     end
   end
   context 'when params[:return] is other content' do
     it 'redirects to student_review#list page' do
       @params[:return] = 'other'
       get :redirect, @params
       expect(response).to redirect_to('/student_review/list?id=1')
     end
   end

Code Climate and Travis CI

There are only cyclomatic, cognitive errors with code climate whereas there are no integration errors with Travis CI

References

1. The pull request for this task can be viewed at: https://github.com/expertiza/expertiza/pull/1383

2. GitHub Repo: https://github.com/Anusha-Godavarthi/expertiza

3. Team Branches: https://github.com/Anusha-Godavarthi/expertiza/branches

4. Expertiza Main Repo https://github.com/expertiza/expertiza

5. Expertiza Documentation http://wiki.expertiza.ncsu.edu/index.php/Main_Page

Team Members

1. Anusha Godavarithi

2. Michael Lewallen

3. Akhil Pabba