CSC/ECE 517 Spring 2020 E2009 Refactor assignment - Revision history

Jsabari: /* Test Plan */

2020-04-02T21:53:33Z

Test Plan

← Older revision		Revision as of 21:53, 2 April 2020
Line 156:		Line 156:

	Our test plan includes rspec tests and testing the GUI in the browser. The rspec tests for the assignment.rb file is pretty much complete with tests written for all the methods called from outside the file. <br> Two rspec tests were failing before we started the refactoring. Those were fixed.		Our test plan includes rspec tests and testing the GUI in the browser. The rspec tests for the assignment.rb file is pretty much complete with tests written for all the methods called from outside the file. <br> Two rspec tests were failing before we started the refactoring. Those were fixed.
	The methods added as part of refactoring are given a private scope and are added in assignment.rb since it is not called from outside. Testing the public methods implicitly tests these private methods. Below is a screenshot our rspec test results. Here is the link to the [~~http://~~https://www.youtube.com/watch?v=zSySTQp3t3w&feature=youtu.be tests] running.		The methods added as part of refactoring are given a private scope and are added in assignment.rb since it is not called from outside. Testing the public methods implicitly tests these private methods. Below is a screenshot our rspec test results. Here is the link to the [https://www.youtube.com/watch?v=zSySTQp3t3w&feature=youtu.be tests] running.

	[[File:s.png]]		[[File:s.png]]

Jsabari: /* Test Plan */

2020-04-02T21:53:14Z

Test Plan

← Older revision		Revision as of 21:53, 2 April 2020
Line 156:		Line 156:

	Our test plan includes rspec tests and testing the GUI in the browser. The rspec tests for the assignment.rb file is pretty much complete with tests written for all the methods called from outside the file. <br> Two rspec tests were failing before we started the refactoring. Those were fixed.		Our test plan includes rspec tests and testing the GUI in the browser. The rspec tests for the assignment.rb file is pretty much complete with tests written for all the methods called from outside the file. <br> Two rspec tests were failing before we started the refactoring. Those were fixed.
	The methods added as part of refactoring are given a private scope and are added in assignment.rb since it is not called from outside. Testing the public methods implicitly tests these private methods. Below is a screenshot our rspec test results.		The methods added as part of refactoring are given a private scope and are added in assignment.rb since it is not called from outside. Testing the public methods implicitly tests these private methods. Below is a screenshot our rspec test results. Here is the link to the [http://https://www.youtube.com/watch?v=zSySTQp3t3w&feature=youtu.be tests] running.

	[[File:s.png]]		[[File:s.png]]

Jsabari: /* Refactoring assignment.rb */

2020-04-01T13:35:14Z

Refactoring assignment.rb

← Older revision		Revision as of 13:35, 1 April 2020
Line 37:		Line 37:
	4) '''Perceived complexity''' - It is a complexity score that's a measure of the complexity the reader experiences when looking at a method. In contrast		4) '''Perceived complexity''' - It is a complexity score that's a measure of the complexity the reader experiences when looking at a method. In contrast
	to the Cyclomatic Complexity, this metric considers `else` nodes as adding complexity.		to the Cyclomatic Complexity, this metric considers `else` nodes as adding complexity.


	All the metrics are quite interlinked, so aiming to reduce one complexity will also reduce other metrics.		All the metrics are quite interlinked, so aiming to reduce one complexity will also reduce other metrics.

Jsabari: /* Refactoring for other good coding practices */

2020-04-01T13:34:49Z

Refactoring for other good coding practices

← Older revision		Revision as of 13:34, 1 April 2020
Line 142:		Line 142:

	[[File:terter.png]]		[[File:terter.png]]


	4. Using Guard Clause instead of wrapping the code inside a conditional expression. <br />		4. Using Guard Clause instead of wrapping the code inside a conditional expression. <br />

Jsabari: /* Refactor scores method */

2020-04-01T13:34:18Z

Refactor scores method

← Older revision		Revision as of 13:34, 1 April 2020
Line 47:		Line 47:
	The scores method is one of the biggest methods in assignment.rb file. The code climate gives the Assignment Branch Condition size as 131.2/15, number of lines of code as 48 and cyclomatic complexity of 8/6.		The scores method is one of the biggest methods in assignment.rb file. The code climate gives the Assignment Branch Condition size as 131.2/15, number of lines of code as 48 and cyclomatic complexity of 8/6.

	The scores method computes and returns the scores of participants and teams as a hash. The participant scores are directly got by calling a method in Participant class. The logic to compute the scores of teams has an outer each loop with one if-else block inside and 2 each loops inside the if block. This resulted in 3 levels of nesting and many lines of code inside the each loop. Below is the screenshot for diff after refactoring (left is refactored code)		The scores method computes and returns the scores of participants and teams as a hash. The participant scores are directly got by calling a method in Participant class. The logic to compute the scores of teams has an outer each loop with one if-else block inside and 2 each loops inside the if block. This resulted in 3 levels of nesting and many lines of code inside the each loop. Two methods are extracted out of this method. Below is the screenshot for diff after refactoring (left is refactored code)

	[[File:scores131313.png]]		[[File:scores131313.png]]

Jsabari at 12:03, 1 April 2020

2020-04-01T12:03:20Z

← Older revision		Revision as of 12:03, 1 April 2020
Line 162:		Line 162:

	We launched expertiza in browser and tested as thorough as possible. On testing the GUI's Assignment page completely, we found that "View Scores" is breaking only for "Project 1" due to a NoMethodError in the Grades#view. "View Scores" of all other projects work as expected. There was also a Routing Error for viewing the survey responses. These errors existed in the base code before we started the refactoring. Since these errors do not pertain to assignment.rb, they have not been fixed. Other than these errors everthing related to assignments works fine.		We launched expertiza in browser and tested as thorough as possible. On testing the GUI's Assignment page completely, we found that "View Scores" is breaking only for "Project 1" due to a NoMethodError in the Grades#view. "View Scores" of all other projects work as expected. There was also a Routing Error for viewing the survey responses. These errors existed in the base code before we started the refactoring. Since these errors do not pertain to assignment.rb, they have not been fixed. Other than these errors everthing related to assignments works fine.

	~~<br>~~

	== Further refactoring possibilities ==		== Further refactoring possibilities ==

	The assignment.rb file has too many methods in one file. It maybe a better idea to move some of the methods which are only used with the views to assignment_helper.rb file.		The assignment.rb file has too many methods in one file. It maybe a better idea to move some of the methods which are only used with the views to assignment_helper.rb file.

Jsabari: /* Refactoring to reduce code complexity */

2020-04-01T12:02:48Z

Refactoring to reduce code complexity

← Older revision		Revision as of 12:02, 1 April 2020
Line 73:		Line 73:

	[[File:s100.jpg]]		[[File:s100.jpg]]


	2) '''Refactoring delete method''' <br />		2) '''Refactoring delete method''' <br />
Line 80:		Line 79:

	[[File:del.png]]		[[File:del.png]]


	===== Reducing cyclomatic complexity and improving code reuse =====		===== Reducing cyclomatic complexity and improving code reuse =====

Jsabari: /* Refactoring to reduce code complexity */

2020-04-01T12:02:32Z

Refactoring to reduce code complexity

← Older revision		Revision as of 12:02, 1 April 2020
Line 80:		Line 80:

	[[File:del.png]]		[[File:del.png]]


	===== Reducing cyclomatic complexity and improving code reuse =====		===== Reducing cyclomatic complexity and improving code reuse =====

Jsabari: /* Refactoring to reduce code complexity */

2020-04-01T12:02:18Z

Refactoring to reduce code complexity

← Older revision		Revision as of 12:02, 1 April 2020
Line 73:		Line 73:

	[[File:s100.jpg]]		[[File:s100.jpg]]


	2) '''Refactoring delete method''' <br />		2) '''Refactoring delete method''' <br />

Jsabari: /* Refactor response_map_to_metareview method */

2020-04-01T12:01:06Z

Refactor response_map_to_metareview method

← Older revision		Revision as of 12:01, 1 April 2020
Line 62:		Line 62:
	=====Refactor response_map_to_metareview method=====		=====Refactor response_map_to_metareview method=====

	This method returns the best review to meta-review map if meta-review exists for a review. It has a sequence of similar operations like sorting the review_respone_map and rejecting certain entries in the review_reponse_map based on certain criteria. We found the same lines repeated in two places, so we extracted that part as one method. In one the method includes a logic to get the reviewers in a map. Even though that task is performed in one place, it is performing a distinct task. Hence that part is also extracted out as a method. Following is the diff after refactoring		This method returns the best review to meta-review map if meta-review exists for a review. It has a sequence of similar operations like sorting the review_respone_map and rejecting certain entries in the review_reponse_map based on certain criteria. We found the same lines repeated in two places, so we extracted that part as one method. In one place the method includes a logic to get the reviewers in a map. Even though that task is performed in one place, it is performing a distinct task. Hence that part is also extracted out as a method. Following is the diff after refactoring


	[[File:response_mappp.png]]		[[File:response_mappp.png]]


	== Refactoring to reduce code complexity ==		== Refactoring to reduce code complexity ==