CSC/ECE 517 Fall 2017/E1745 Refactor response controller.rb - Revision history

Dgupta10: /* References */

2017-11-03T02:12:09Z

References

← Older revision		Revision as of 02:12, 3 November 2017
Line 283:		Line 283:
	=='''References'''==		=='''References'''==
	1. Expertiza Main Repo [https://github.com/expertiza/expertiza]		1. Expertiza Main Repo [https://github.com/expertiza/expertiza]

	2. Expertiza Documentation [http://wiki.expertiza.ncsu.edu/index.php/Main_Page]		2. Expertiza Documentation [http://wiki.expertiza.ncsu.edu/index.php/Main_Page]

	3. Pull Request [https://github.com/expertiza/expertiza/pull/1025]		3. Pull Request [https://github.com/expertiza/expertiza/pull/1025]

	4. Screencast for E1745 [https://www.youtube.com/watch?v=VfiPCQmnuAc]		4. Screencast for E1745 [https://www.youtube.com/watch?v=VfiPCQmnuAc]

Dgupta10 at 02:11, 3 November 2017

2017-11-03T02:11:56Z

← Older revision		Revision as of 02:11, 3 November 2017
Line 280:		Line 280:

	We wrote stubs and mocks required to successfully test all the pieces of the controller. All of it can be viewed in response_controller_spec.rb.		We wrote stubs and mocks required to successfully test all the pieces of the controller. All of it can be viewed in response_controller_spec.rb.

			=='''References'''==
			1. Expertiza Main Repo [https://github.com/expertiza/expertiza]
			2. Expertiza Documentation [http://wiki.expertiza.ncsu.edu/index.php/Main_Page]
			3. Pull Request [https://github.com/expertiza/expertiza/pull/1025]
			4. Screencast for E1745 [https://www.youtube.com/watch?v=VfiPCQmnuAc]

Dgupta10: /* Refactoring Explained */

2017-11-03T02:07:50Z

Refactoring Explained

← Older revision		Revision as of 02:07, 3 November 2017
Line 100:		Line 100:

	This has extracted an independent functionality and enhanced readability apart from sticking to guidelines of short methods.		This has extracted an independent functionality and enhanced readability apart from sticking to guidelines of short methods.


	==='''Replaced find_by_map_id with find_by'''===		==='''Replaced find_by_map_id with find_by'''===

Dgupta10: /* Replaced find_by_map_id with find_by */

2017-11-03T02:07:21Z

Replaced find_by_map_id with find_by

← Older revision		Revision as of 02:07, 3 November 2017
Line 119:		Line 119:

	This will avoid any unexpected behaviour when further upgrading the Rails framework.		This will avoid any unexpected behaviour when further upgrading the Rails framework.


	==='''Replacing sorting technique'''===		==='''Replacing sorting technique'''===

Dgupta10: /* Refactoring Explained */

2017-11-03T02:07:08Z

Refactoring Explained

← Older revision		Revision as of 02:07, 3 November 2017
Line 26:		Line 26:
	Without wasting much time, lets jump into the refactoring by describing code which existed previously followed by the changed code.		Without wasting much time, lets jump into the refactoring by describing code which existed previously followed by the changed code.

	1) action_allowed? method		==='''action_allowed? method'''===

	Previous Code :-		Previous Code :-
Line 102:		Line 102:


	2) Replaced find_by_map_id with find_by		==='''Replaced find_by_map_id with find_by'''===

	<pre>		<pre>
Line 121:		Line 121:


	3) Replacing sorting technique		==='''Replacing sorting technique'''===

	<pre>		<pre>
Line 139:		Line 139:
	This is the way to sort based on an object attribute.		This is the way to sort based on an object attribute.

	4) Refactoring pending_surveys method		==='''Refactoring pending_surveys method'''===

	<pre>		<pre>

Dgupta10: /* Introduction */

2017-11-03T02:05:31Z

Introduction

← Older revision		Revision as of 02:05, 3 November 2017
Line 1:		Line 1:
	==Introduction==		=='''Introduction'''==
	Expertiza is an open source webapp 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 being built and maintained by students and faculty at NCSU.		Expertiza is an open source webapp 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 being built and maintained by students and faculty at NCSU.

Dgupta10: /* About response_controller.rb */

2017-11-03T02:05:20Z

About response_controller.rb

← Older revision		Revision as of 02:05, 3 November 2017
Line 2:		Line 2:
	Expertiza is an open source webapp 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 being built and maintained by students and faculty at NCSU.		Expertiza is an open source webapp 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 being built and maintained by students and faculty at NCSU.

	==About response_controller.rb==		=='''About response_controller.rb'''==
	The file response_controller.rb handles the operations on responses based on user permissions and redirects the user to the appropriate place after the action is complete. The responses here constitute of peer reviews/questionnaires/survey. 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 and redirects the user to the appropriate place after the action is complete. The responses here constitute of peer reviews/questionnaires/survey. The controller takes care of tasks such as creating, saving, editing, updating and deleting these responses.

Dgupta10: /* Tasks accomplished */

2017-11-03T02:05:10Z

Tasks accomplished

← Older revision		Revision as of 02:05, 3 November 2017
Line 5:		Line 5:
	The file response_controller.rb handles the operations on responses based on user permissions and redirects the user to the appropriate place after the action is complete. The responses here constitute of peer reviews/questionnaires/survey. 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 and redirects the user to the appropriate place after the action is complete. The responses here constitute of peer reviews/questionnaires/survey. The controller takes care of tasks such as creating, saving, editing, updating and deleting these responses.

	==Tasks accomplished==		=='''Tasks accomplished'''==
	1. Refactoring response_controller.rb		1. Refactoring response_controller.rb

Dgupta10: /* Refactoring Explained */

2017-11-03T02:04:59Z

Refactoring Explained

← Older revision		Revision as of 02:04, 3 November 2017
Line 23:		Line 23:
	The pull request for this task can be viewed at [https://github.com/expertiza/expertiza/pull/1025]		The pull request for this task can be viewed at [https://github.com/expertiza/expertiza/pull/1025]

	==Refactoring Explained==		=='''Refactoring Explained'''==
	Without wasting much time, lets jump into the refactoring by describing code which existed previously followed by the changed code.		Without wasting much time, lets jump into the refactoring by describing code which existed previously followed by the changed code.

Dgupta10: /* Test Plan and Execution */

2017-11-03T02:04:44Z

Test Plan and Execution

← Older revision		Revision as of 02:04, 3 November 2017
Line 241:		Line 241:
	</pre>		</pre>

	==Test Plan and Execution==		=='''Test Plan and Execution'''==
	23 integration tests were written to ensure the functionality works and also to make sure the refactoring does not break any of the existing functionality.		23 integration tests were written to ensure the functionality works and also to make sure the refactoring does not break any of the existing functionality.
	These tests check for the basic functionality of the controller response_controller.rb and whether these function calls redirect to the right place with the correct status code. Consider the following example.		These tests check for the basic functionality of the controller response_controller.rb and whether these function calls redirect to the right place with the correct status code. Consider the following example.