E1917 Fix Code Climate Issues - Revision history

Zwu17: /* Code Climate Issues and Problem Statements */

2019-03-25T20:44:21Z

Code Climate Issues and Problem Statements

← Older revision		Revision as of 20:44, 25 March 2019
Line 6:		Line 6:
	== '''Code Climate Issues and Problem Statements''' ==		== '''Code Climate Issues and Problem Statements''' ==

	Codeclimate is a command line interface for the Code Climate analysis platform. It could detect code smells which violate ruby/rails best practices. The task is to fix certain code climate issues detected by Code Climate analysis platform in controllers with the name begin with P to Z. Those issues includes unsafe use of methods, inappropriate syntax, non-optimal code structure and so on. There are totally 48 different types of issues fixed in this project.		Codeclimate is a command line interface for the Code Climate analysis platform. It could detect code smells which violate ruby/rails best practices. The task is to fix certain code climate issues detected by Code Climate analysis platform in controllers with the name begin with P to Z. Those issues includes unsafe use of methods, inappropriate syntax, non-optimal code structure and so on. There are totally 33 different types of issues fixed in this project.


Line 12:		Line 12:

	<code>		<code>
	1. Unprotected mass assignment		1. Unprotected mass assignment

	2. Use a guard clause instead of wrapping the code inside a conditional expression		2. Use a guard clause instead of wrapping the code inside a conditional expression

	3. Do not use Time.now without zone. Use one of Time.zone.now, Time.current, Time.now.in_time_zone, Time.now.utc, Time.now.getlocal, Time.now.iso8601, Time.now.jisx0301, Time.now.rfc3339, Time.now.to_i, Time.now.to_f instead		3. Do not use Time.now without zone. Use one of Time.zone.now, Time.current, Time.now.in_time_zone, Time.now.utc, Time.now.getlocal, Time.now.iso8601, Time.now.jisx0301, Time.now.rfc3339, Time.now.to_i, Time.now.to_f instead

	4. Move redirect_to "/" out of the conditional.		4. Move redirect_to "/" out of the conditional.
Line 36:		Line 36:
	12. Parameters should be whitelisted for mass assignment		12. Parameters should be whitelisted for mass assignment

	14. Avoid using update_attribute because it skips validations.		13. Avoid using update_attribute because it skips validations.

	14. end at 44, 4 is not aligned with def at 39, 2.		14. end at 44, 4 is not aligned with def at 39, 2.

	15. Unsafe reflection method const_get called with parameter value		15. Unsafe reflection method const_get called with parameter value

	~~16. Avoid more than 3 levels of block nesting.~~

	17. ~~Use each_key instead of keys.each~~		16. TODO found

	18. ~~FIXME found~~		17. Convert if nested inside else to elsif

	19. ~~TODO~~ found		18. Similar blocks of code found in 3 locations. Consider refactoring

	20. ~~Useless assignment to variable - parent~~		19. User controlled method execution

	21. ~~Convert if nested inside else to elsif~~		20. Extra blank line detected

	22. ~~Move q~~.~~save out of the conditional~~		21. Use empty lines between method definitions.

	23. ~~Similar blocks of code found in 3 locations. Consider refactoring~~		22. Prefer each over for

	24. ~~User controlled method execution~~		23. Prefer Date or Time over DateTime.

	~~25. Replace class var @@assignment_id with a class instance var~~.		24. Omit parentheses for ternary conditions

	26. ~~Avoid comparing a variable with multiple items in a conditional, use Array#include? Instead~~.		25. Do not place comments on the same line as the end keyword.

	27. ~~Extra blank line detected~~.		26. Useless assignment to variable - controllers. Did you mean controller?

	28. Do not ~~prefix writer method names~~ with ~~set_~~		27. end at 135, 2 is not aligned with class at 1, 0

	29. ~~Ternary operators must not be nested. Prefer if or else constructs instead~~.		28. Put one space between the method name and the first argument.

	30. ~~Use empty lines between method definitions~~.		29. Space missing after colon.

	31. Use ~~student_review_num.zero? instead of student_review_num == 0~~.		30. Use the new Ruby 1.9 hash syntax

	32. ~~Use normalcase for variable numbers~~.		31. show, edit, update, destroy are not explicitly defined on the controller.

	~~33. Use only ascii symbols in comments~~.		32. Rename is_user_ta? to user_ta?

	~~34. Possible SQL injection~~		33. Avoid comma after the last item of an array

	~~35. Use find_by instead of dynamic find_by_name~~

	~~36. Prefer each over for~~

	~~37. Use snake_case for variable names.~~

	~~39. Prefer Date or Time over DateTime.~~

	~~40. Omit parentheses for ternary conditions~~

	~~41. Do not place comments on the same line as the end keyword.~~

	~~42. end at 135, 2 is not aligned with class at 1, 0~~

	~~43. Put one space between the method name and the first argument.~~

	~~44. Space missing after colon.~~

	~~45. Use the new Ruby 1.9 hash syntax~~

	~~46. show, edit, update, destroy are not explicitly defined on the controller.~~

	~~47. Rename is_user_ta? to user_ta?~~

	48. Avoid comma after the last item of an array
	</code>		</code>

Zwu17: /* Testing */

2019-03-25T19:53:45Z

Testing

← Older revision		Revision as of 19:53, 25 March 2019
Line 114:		Line 114:

	The Expertiza project provides 77 rspec tests under expertiza/spec and 8 of them are related to our controllers files. After modifying those 28 files, we want to make sure these tests could still pass. We passed all the Rspec tests except for "response_controller". However, we were not requirement to fix the issues for this controllers.		The Expertiza project provides 77 rspec tests under expertiza/spec and 8 of them are related to our controllers files. After modifying those 28 files, we want to make sure these tests could still pass. We passed all the Rspec tests except for "response_controller". However, we were not requirement to fix the issues for this controllers.




	[[File:Testing pass.png]]		[[File:Testing pass.png]]

Zwu17: /* Testing */

2019-03-25T19:49:39Z

Testing

← Older revision		Revision as of 19:49, 25 March 2019
Line 116:		Line 116:

	[[File:Testing pass.png]]		[[File:Testing pass.png]]


			[[File:One_failure_testing.png]]

	== ''Reference'' ==		== ''Reference'' ==

Zwu17: /* Testing */

2019-03-25T19:46:40Z

Testing

← Older revision		Revision as of 19:46, 25 March 2019
Line 114:		Line 114:

	The Expertiza project provides 77 rspec tests under expertiza/spec and 8 of them are related to our controllers files. After modifying those 28 files, we want to make sure these tests could still pass. We passed all the Rspec tests except for "response_controller". However, we were not requirement to fix the issues for this controllers.		The Expertiza project provides 77 rspec tests under expertiza/spec and 8 of them are related to our controllers files. After modifying those 28 files, we want to make sure these tests could still pass. We passed all the Rspec tests except for "response_controller". However, we were not requirement to fix the issues for this controllers.

			[[File:Testing pass.png]]

	== ''Reference'' ==		== ''Reference'' ==

Zwu17: /* Implementation */

2019-03-25T19:46:12Z

Implementation

← Older revision		Revision as of 19:46, 25 March 2019
Line 110:		Line 110:

	There are many minor issues such as unnecessary spacing, change "for" to "each" for loop, extra blank line detected, omitted parentheses used and so on. We're not going to show all these minor fixing on this section but just show some important issues we fixed.		There are many minor issues such as unnecessary spacing, change "for" to "each" for loop, extra blank line detected, omitted parentheses used and so on. We're not going to show all these minor fixing on this section but just show some important issues we fixed.


	~~[[File:Testing pass.png]]~~

	== '''Testing''' ==		== '''Testing''' ==

Zwu17: /* Implementation */

2019-03-25T19:45:53Z

Implementation

← Older revision		Revision as of 19:45, 25 March 2019
Line 110:		Line 110:

	There are many minor issues such as unnecessary spacing, change "for" to "each" for loop, extra blank line detected, omitted parentheses used and so on. We're not going to show all these minor fixing on this section but just show some important issues we fixed.		There are many minor issues such as unnecessary spacing, change "for" to "each" for loop, extra blank line detected, omitted parentheses used and so on. We're not going to show all these minor fixing on this section but just show some important issues we fixed.


			[[File:Testing pass.png]]

	== '''Testing''' ==		== '''Testing''' ==

Zwu17: /* Testing */

2019-03-25T19:31:58Z

Testing

← Older revision		Revision as of 19:31, 25 March 2019
Line 113:		Line 113:
	== '''Testing''' ==		== '''Testing''' ==

	The Expertiza project provides 77 rspec tests under expertiza/spec and 8 of them are related to our controllers files. After modifying those 28 files, we want to make sure these tests could still pass.		The Expertiza project provides 77 rspec tests under expertiza/spec and 8 of them are related to our controllers files. After modifying those 28 files, we want to make sure these tests could still pass. We passed all the Rspec tests except for "response_controller". However, we were not requirement to fix the issues for this controllers.

	== ''Reference'' ==		== ''Reference'' ==

Zwu17: /* Testing */

2019-03-25T19:04:42Z

Testing

← Older revision		Revision as of 19:04, 25 March 2019
Line 113:		Line 113:
	== '''Testing''' ==		== '''Testing''' ==

	The Expertiza project provides 77 rspec tests under expertiza/spec. 8 of them are related to our controllers files. After modifying those 28 files, we want to make sure these tests could still pass.		The Expertiza project provides 77 rspec tests under expertiza/spec and 8 of them are related to our controllers files. After modifying those 28 files, we want to make sure these tests could still pass.

	== ''Reference'' ==		== ''Reference'' ==

Zwu17: /* Code Climate Issues and Problem Statements */

2019-03-25T19:03:26Z

Code Climate Issues and Problem Statements

← Older revision		Revision as of 19:03, 25 March 2019
Line 11:		Line 11:
	'''Below is a list of all issues we have fixed.'''		'''Below is a list of all issues we have fixed.'''

			<code>
	1. Unprotected mass assignment		1. Unprotected mass assignment

Line 105:		Line 105:

	48. Avoid comma after the last item of an array		48. Avoid comma after the last item of an array
			</code>

	== '''Implementation''' ==		== '''Implementation''' ==

Zwu17: /* Code Climate Issues and Problem Statements */

2019-03-25T15:46:12Z

Code Climate Issues and Problem Statements

← Older revision		Revision as of 15:46, 25 March 2019
Line 8:		Line 8:
	Codeclimate is a command line interface for the Code Climate analysis platform. It could detect code smells which violate ruby/rails best practices. The task is to fix certain code climate issues detected by Code Climate analysis platform in controllers with the name begin with P to Z. Those issues includes unsafe use of methods, inappropriate syntax, non-optimal code structure and so on. There are totally 48 different types of issues fixed in this project.		Codeclimate is a command line interface for the Code Climate analysis platform. It could detect code smells which violate ruby/rails best practices. The task is to fix certain code climate issues detected by Code Climate analysis platform in controllers with the name begin with P to Z. Those issues includes unsafe use of methods, inappropriate syntax, non-optimal code structure and so on. There are totally 48 different types of issues fixed in this project.

	Below is a list of all issues we have fixed.
			'''Below is a list of all issues we have fixed.'''