CSC517 Spring 2019/E1923 New Framework For Import/Export - Revision history

Jrnolan2: /* Export Changes */ fix typo

2024-03-27T06:46:54Z

Export Changes: fix typo

← Older revision		Revision as of 06:46, 27 March 2024
Line 231:		Line 231:
	== Export Changes ==		== Export Changes ==

	The goal was to get all the export functionality routed through one place, the ExportFileController. The overall effect would have been similar to what we hope to ~~achomplish~~ when updating the import functionality.		The goal was to get all the export functionality routed through one place, the ExportFileController. The overall effect would have been similar to what we hope to accomplish when updating the import functionality.

	We ran out of time to work on this functionality.		We ran out of time to work on this functionality.

Vkhanna: /* Models */

2019-05-01T20:44:29Z

Models

← Older revision		Revision as of 20:44, 1 May 2019
Line 105:		Line 105:
	[[Image: importmethod.png]]		[[Image: importmethod.png]]

	[[Image: ~~show~~.png]]		[[Image: showmethod.png]]

	*Questionnaire.rb has a #import method that is now routed through the ImportFileController and the actual act of importing works. We removed all functionality related to importing from the QuestionnaireController and QuestionnaireHelper.		*Questionnaire.rb has a #import method that is now routed through the ImportFileController and the actual act of importing works. We removed all functionality related to importing from the QuestionnaireController and QuestionnaireHelper.

Vkhanna: /* Models */

2019-05-01T20:41:49Z

Models

← Older revision		Revision as of 20:41, 1 May 2019
Line 101:		Line 101:
	*In the ImportFileController we moved the #start method to the beginning of the file for consistency and readability.		*In the ImportFileController we moved the #start method to the beginning of the file for consistency and readability.

	*The #import_from_hash and the #show method inside the ImportFileController is markedly shorter now then when we found it. We removed most of the case statements.		*The #import_from_hash and the #show method inside the ImportFileController is markedly shorter now then when we found it. We removed most of the case statements. The below images are in the respective order.

			[[Image: importmethod.png]]

			[[Image: show.png]]

	*Questionnaire.rb has a #import method that is now routed through the ImportFileController and the actual act of importing works. We removed all functionality related to importing from the QuestionnaireController and QuestionnaireHelper.		*Questionnaire.rb has a #import method that is now routed through the ImportFileController and the actual act of importing works. We removed all functionality related to importing from the QuestionnaireController and QuestionnaireHelper.

Vkhanna: /* Code Climate */

2019-05-01T20:38:31Z

Code Climate

← Older revision		Revision as of 20:38, 1 May 2019
Line 182:		Line 182:

	There were many code climate issues in reference to our project. We have managed to fix 46 issues as a byproduct of refactoring the code. Here is a list of them with their frequency put in parenthesis':		There were many code climate issues in reference to our project. We have managed to fix 46 issues as a byproduct of refactoring the code. Here is a list of them with their frequency put in parenthesis':
	~~<pre>~~
	~~- Method get_questions_from_csv has a Cognitive Complexity of 62 (exceeds 5 allowed). Consider refactoring.~~

	- Method get_questions_from_csv has ~~41 lines~~ of ~~code~~ (exceeds 25 allowed). Consider refactoring.		* Method get_questions_from_csv has a Cognitive Complexity of 62 (exceeds 5 allowed). Consider refactoring.

	~~- File import_file_controller.rb~~ has ~~278~~ lines of code (exceeds ~~250~~ allowed). Consider refactoring.		* Method get_questions_from_csv has 41 lines of code (exceeds 25 allowed). Consider refactoring.

	~~- Avoid deeply nested control flow statements~~. (3)		* File import_file_controller.rb has 278 lines of code (exceeds 250 allowed). Consider refactoring.

	~~- Similar blocks of code found in 2 locations. Consider refactoring~~. (2)		* Avoid deeply nested control flow statements. (3)

	~~- Unescaped parameter value~~		* Similar blocks of code found in 2 locations. Consider refactoring. (2)

	~~- Useless assignment to variable - a.~~		* Unescaped parameter value

	- ~~Cyclomatic complexity for get_questions_from_csv is too high~~. ~~[18/6]~~		* Useless assignment to variable - a.

	~~- Assignment Branch Condition size~~ for get_questions_from_csv is too high. [~~43.3~~/15]		* Cyclomatic complexity for get_questions_from_csv is too high. [18/6]

	~~- Block has~~ too ~~many lines~~. [36/25]		* Assignment Branch Condition size for get_questions_from_csv is too high. [43.3/15]

	~~- Avoid more than 3 levels of block nesting~~. ~~(3)~~		* Block has too many lines. [36/25]

	~~- Perceived complexity for get_questions_from_csv is too high~~. ~~[16/7]~~		* Avoid more than 3 levels of block nesting. (3)

	~~- Align elsif with if~~.		* Perceived complexity for get_questions_from_csv is too high. [16/7]

	~~- Space missing after comma~~. ~~(13)~~		* Align elsif with if.

	~~- Line is too long~~. ~~[172/160]~~		* Space missing after comma. (13)

	~~- Method has~~ too ~~many lines~~. [~~108~~/60]		* Line is too long. [172/160]

	~~- Use the return of the conditional for variable assignment and comparison~~.		* Method has too many lines. [108/60]

	~~- Move @optional_count = 0 out~~ of the conditional. ~~(2)~~		* Use the return of the conditional for variable assignment and comparison.

	- Move ~~contents_hash~~ = ~~eval(params[:contents_hash])~~ out of the conditional. (6)		* Move @optional_count = 0 out of the conditional. (2)

	~~- Convert if nested inside else to elsif~~.		* Move contents_hash = eval(params[:contents_hash]) out of the conditional. (6)

	- Don't use parentheses around the condition of an if. (3)		* Convert if nested inside else to elsif.
	~~</pre>~~
			* Don't use parentheses around the condition of an if. (3)

	== Export Changes ==		== Export Changes ==

Vkhanna: /* What has been done */

2019-05-01T20:34:31Z

What has been done

← Older revision		Revision as of 20:34, 1 May 2019
Line 182:		Line 182:

	There were many code climate issues in reference to our project. We have managed to fix 46 issues as a byproduct of refactoring the code. Here is a list of them with their frequency put in parenthesis':		There were many code climate issues in reference to our project. We have managed to fix 46 issues as a byproduct of refactoring the code. Here is a list of them with their frequency put in parenthesis':
			<pre>
	- Method get_questions_from_csv has a Cognitive Complexity of 62 (exceeds 5 allowed). Consider refactoring.		- Method get_questions_from_csv has a Cognitive Complexity of 62 (exceeds 5 allowed). Consider refactoring.

Line 224:		Line 224:

	- Don't use parentheses around the condition of an if. (3)		- Don't use parentheses around the condition of an if. (3)
			</pre>

	== Export Changes ==		== Export Changes ==

Vkhanna: /* Team */

2019-04-27T00:53:16Z

Team

← Older revision		Revision as of 00:53, 27 April 2019
Line 1:		Line 1:
	== Project Introduction ==		== Project Introduction ==
	=== Team ===		=== Team ===
			*Drew Marshburn, rdmarshb
	*Veeha Khanna, vkhanna		*Veeha Khanna, vkhanna
	*Randy Paluszkiewicz, rpalusz		*Randy Paluszkiewicz, rpalusz
	*Drew Marshburn, rdmarshb
	*Andrew Miller, asmille5		*Andrew Miller, asmille5

Vkhanna: /* Test Plan */

2019-04-27T00:41:38Z

Test Plan

← Older revision		Revision as of 00:41, 27 April 2019
Line 246:		Line 246:
	*'''user'''		*'''user'''

	~~We have a test that is failing that is not related to our changes.~~ There is one failing test about exporting and we have not touched export functionality.		There is one failing test about exporting and we have not touched export functionality. There is another failing test about a review tab that we didn't touch.

	== Deployment ==		== Deployment ==

Vkhanna: /* Test Plan */

2019-04-27T00:22:01Z

Test Plan

← Older revision		Revision as of 00:22, 27 April 2019
Line 246:		Line 246:
	*'''user'''		*'''user'''

	We have a ~~few tests~~ that ~~are~~ failing that ~~are~~ not related to our changes. ~~ADD TO THIS~~		We have a test that is failing that is not related to our changes. There is one failing test about exporting and we have not touched export functionality.

	== Deployment ==		== Deployment ==

Vkhanna: /* Deployment */

2019-04-26T20:15:51Z

Deployment

← Older revision		Revision as of 20:15, 26 April 2019
Line 250:		Line 250:
	== Deployment ==		== Deployment ==

	The project is deployed on an NCSU VCL server. It can be accessed at http://152.46.16.~~252~~:8080/.		The project is deployed on an NCSU VCL server. It can be accessed at http://152.46.17.230:8080/.

	A sample instructor login is:		A sample instructor login is:

Vkhanna: /* Code Climate */

2019-04-26T19:28:09Z

Code Climate

← Older revision		Revision as of 19:28, 26 April 2019
Line 179:		Line 179:

	=== Code Climate ===		=== Code Climate ===
	'''Note:		'''Note: Code Climate was not running on Expertiza's beta branch for the last four days of the project. We have done the best we could to removed extraneous lines and white spaces.'''

	There were many code climate issues in reference to our project. We have managed to fix 46 issues as a byproduct of refactoring the code. Here is a list of them with their frequency put in parenthesis':		There were many code climate issues in reference to our project. We have managed to fix 46 issues as a byproduct of refactoring the code. Here is a list of them with their frequency put in parenthesis':