CSC/ECE 517 Spring 2019 E1910 Refactor assignments controller.rb - Revision history

Bnmwanik at 14:47, 2 April 2019

2019-04-02T14:47:44Z

← Older revision		Revision as of 14:47, 2 April 2019
Line 104:		Line 104:

	The code coverage for the controller was 49% when we got the project. The code coverage when we finished was 53.32%.		The code coverage for the controller was 49% when we got the project. The code coverage when we finished was 53.32%.

			There is a video on Expertiza titled "Rspec_test.mp4" which shows the updated tests running successfully.

	=== RSpec Tests ===		=== RSpec Tests ===

Bnmwanik at 22:50, 1 April 2019

2019-04-01T22:50:51Z

← Older revision		Revision as of 22:50, 1 April 2019
Line 85:		Line 85:

	New '''create''' method:		New '''create''' method:

	~~[[File:new_create_method.png\|800px\|thumb\|left\|new create method]]~~


	[[File:new_create_method.png]]		[[File:new_create_method.png]]

Bnmwanik at 22:45, 1 April 2019

2019-04-01T22:45:06Z

← Older revision		Revision as of 22:45, 1 April 2019
Line 85:		Line 85:

	New '''create''' method:		New '''create''' method:

			[[File:new_create_method.png\|800px\|thumb\|left\|new create method]]


	[[File:new_create_method.png]]		[[File:new_create_method.png]]

Pjain22: /* RSpec Tests */

2019-04-01T22:34:32Z

RSpec Tests

← Older revision		Revision as of 22:34, 1 April 2019
Line 109:		Line 109:
	There were already quite a few test cases for the AssignmentsController ('''assignments_controller_spec.rb'''). The '''create''' block tested just about everything. The two methods we added are private and since we branched out some functionality this needed to be a bit more explicitly tested. There is no precedence for testing private methods and it was frowned upon as per the video ''The Magic Tricks of Testing''. We tested the public method, '''create''', that calls the private method, '''update_assignment_form''' and '''array_traverser'''. We added a test with the context ''when assignment_form is saved successfully but fails to update''.		There were already quite a few test cases for the AssignmentsController ('''assignments_controller_spec.rb'''). The '''create''' block tested just about everything. The two methods we added are private and since we branched out some functionality this needed to be a bit more explicitly tested. There is no precedence for testing private methods and it was frowned upon as per the video ''The Magic Tricks of Testing''. We tested the public method, '''create''', that calls the private method, '''update_assignment_form''' and '''array_traverser'''. We added a test with the context ''when assignment_form is saved successfully but fails to update''.

	For the other untested public methods, we found no usage directly in the controller therefore we did not test them.		For the other untested public methods, we found no usage directly in the controller, therefore, we did not test them. These methods are performing the tasks of assigning values to the variables and therefore that is being tested in other methods of the controllers.

	No changes were made to the associated views and model file.		No changes were made to the associated views and model file.

Vkhanna: /* Test Plan */

2019-04-01T20:03:10Z

Test Plan

← Older revision		Revision as of 20:03, 1 April 2019
Line 103:		Line 103:
	== Test Plan ==		== Test Plan ==

	The code coverage for the controller was 49% when we got the project. The code coverage when we finished was ~~FINISH THIS~~.		The code coverage for the controller was 49% when we got the project. The code coverage when we finished was 53.32%.

	=== RSpec Tests ===		=== RSpec Tests ===
Line 109:		Line 109:
	There were already quite a few test cases for the AssignmentsController ('''assignments_controller_spec.rb'''). The '''create''' block tested just about everything. The two methods we added are private and since we branched out some functionality this needed to be a bit more explicitly tested. There is no precedence for testing private methods and it was frowned upon as per the video ''The Magic Tricks of Testing''. We tested the public method, '''create''', that calls the private method, '''update_assignment_form''' and '''array_traverser'''. We added a test with the context ''when assignment_form is saved successfully but fails to update''.		There were already quite a few test cases for the AssignmentsController ('''assignments_controller_spec.rb'''). The '''create''' block tested just about everything. The two methods we added are private and since we branched out some functionality this needed to be a bit more explicitly tested. There is no precedence for testing private methods and it was frowned upon as per the video ''The Magic Tricks of Testing''. We tested the public method, '''create''', that calls the private method, '''update_assignment_form''' and '''array_traverser'''. We added a test with the context ''when assignment_form is saved successfully but fails to update''.

			For the other untested public methods, we found no usage directly in the controller therefore we did not test them.

	No changes were made to the associated views and model file.		No changes were made to the associated views and model file.

Vkhanna: /* Code Improvements */

2019-04-01T19:35:50Z

Code Improvements

← Older revision		Revision as of 19:35, 1 April 2019
Line 72:		Line 72:
	The delegation pattern states, "In delegation, an object handles a request by delegating to a second object (the delegate). The delegate is a helper object, but with the original context." [5]		The delegation pattern states, "In delegation, an object handles a request by delegating to a second object (the delegate). The delegate is a helper object, but with the original context." [5]

	As something extra, the '''create''' method was refactored so that the branch condition would be lower and there would be no repetition. As per ~~the delegation design~~ pattern we took a request from the '''create''' method and put it in a helper method called '''update_assignment_form'''. This method handles updating the id of the ''assignment_questionnaire'' and the ''due_date'' and updating the form accordingly. The '''create''' method delegates this task to the '''update_assignment_form'''.		As something extra, the '''create''' method was refactored so that the branch condition would be lower and there would be no repetition. We decided to use the delegation pattern because it serves the purpose of cleaning up existing methods while maintaining functionality. As per this pattern we took a request from the '''create''' method and put it in a helper method called '''update_assignment_form'''. This method handles updating the id of the ''assignment_questionnaire'' and the ''due_date'' and updating the form accordingly. The '''create''' method delegates this task to the '''update_assignment_form'''.

	The '''update_assignment_form''' delegated a tasks to the helper method, '''array_traverser'''. This method does the job of going through the array and ~~depending on the option a specific field will get updated~~.		The '''update_assignment_form''' delegated a tasks to the helper method, '''array_traverser'''. This method does the job of going through the array and updates id fields to be strings instead of an integer.

Vkhanna: /* Test Plan */

2019-03-31T19:45:03Z

Test Plan

← Older revision		Revision as of 19:45, 31 March 2019
Line 103:		Line 103:
	== Test Plan ==		== Test Plan ==

	The code coverage for the controller was 49% when we got the project.		The code coverage for the controller was 49% when we got the project. The code coverage when we finished was FINISH THIS.

	=== ~~Existing~~ RSpec Tests ===		=== RSpec Tests ===
	#There were already quite a few test cases for the AssignmentsController ('''assignments_controller_spec.rb'''). We have not added any new tests but made sure #that no tests were failing due to our changes. No changes were made to the associated views and model file.

	~~=== New Rspec Test ===~~		There were already quite a few test cases for the AssignmentsController ('''assignments_controller_spec.rb'''). The '''create''' block tested just about everything. The two methods we added are private and since we branched out some functionality this needed to be a bit more explicitly tested. There is no precedence for testing private methods and it was frowned upon as per the video ''The Magic Tricks of Testing''. We tested the public method, '''create''', that calls the private method, '''update_assignment_form''' and '''array_traverser'''. We added a test with the context ''when assignment_form is saved successfully but fails to update''.

	~~In progress..~~.
			No changes were made to the associated views and model file.

	== References ==		== References ==

Vkhanna: /* Test Plan */

2019-03-31T19:26:36Z

Test Plan

← Older revision		Revision as of 19:26, 31 March 2019
Line 106:		Line 106:

	=== Existing RSpec Tests ===		=== Existing RSpec Tests ===
	There were already quite a few test cases for the AssignmentsController ('''assignments_controller_spec.rb'''). We have not added any new tests but made sure that no tests were failing due to our changes. No changes were made to the associated views and model file.		#There were already quite a few test cases for the AssignmentsController ('''assignments_controller_spec.rb'''). We have not added any new tests but made sure #that no tests were failing due to our changes. No changes were made to the associated views and model file.

	=== New Rspec Test ===		=== New Rspec Test ===

Vkhanna: /* Test Plan */

2019-03-31T17:56:24Z

Test Plan

← Older revision		Revision as of 17:56, 31 March 2019
Line 102:		Line 102:

	== Test Plan ==		== Test Plan ==

			The code coverage for the controller was 49% when we got the project.

	=== Existing RSpec Tests ===		=== Existing RSpec Tests ===

Vkhanna: /* Files modified in current project */

2019-03-31T17:52:05Z

Files modified in current project

← Older revision		Revision as of 17:52, 31 March 2019
Line 29:		Line 29:
	- assignment_form_key_nonexist_case_handler		- assignment_form_key_nonexist_case_handler
	-- assignment_submission_handler		-- assignment_submission_handler
	- ~~Handle_current_user_timezonepref_nil~~		- handle_current_user_timezonepref_nil
	-- timezone_handler		-- timezone_handler
	- update_nil_dd_deadline_name		- update_nil_dd_deadline_name
Line 42:		Line 42:
	-- update_feedback_attributes		-- update_feedback_attributes

	The thought process behind changing the method names was to make the names shorter and reduce redundancy. There were a few rules that we learned from our mentor; words like ''nil'' and ''nonexist'' are not allowed in method names. So for '''~~Handle_current_user_timezonepref_nil~~''' we first removed the ''nil''. Then after looking at what the method does we determined that '''timezone_handler''' would be appropriate and tells the user enough at a moments glance. More information is available about the method in the form of a block comment.		The thought process behind changing the method names was to make the names shorter and reduce redundancy. There were a few rules that we learned from our mentor; words like ''nil'' and ''nonexist'' are not allowed in method names. So for '''handle_current_user_timezonepref_nil''' we first removed the ''nil''. Then after looking at what the method does we determined that '''timezone_handler''' would be appropriate and tells the user enough at a moments glance. More information is available about the method in the form of a block comment.

	Another example is '''assignment_form_assignment_staggered_deadline?''', the ''assignment_form'' bit is redundant, since it is the assignments controller the beginning part does not provide any new information and '''assignment_staggered_deadline?''' is sufficient.		Another example is '''assignment_form_assignment_staggered_deadline?''', the ''assignment_form'' bit is redundant, since it is the assignments controller the beginning part does not provide any new information and '''assignment_staggered_deadline?''' is sufficient.