CSC/ECE 517 Spring 2017/E1724 - Revision history

Mdunlap at 02:08, 1 April 2017

2017-04-01T02:08:48Z

@@ Line 22: / Line 22: @@
 This method took time stamps using time_parse function, which would create issues when users change their time zones. Calling time_zone_parse instead of time_parse solves the issue. This method also had massive duplicate code for different test scenarios. A helper method enqueue_delayed_job(stage) is used to encapsulate the task being performed.
-After refactoring in delayed_mailer_spec.rb:
+After refactoring in delayed_mailer_spec.rb each of the test cases were written in less than five lines of code.
 '''Refactoring Scheduled_task_spec Method'''
@@ Line 41: / Line 29: @@
 This method took time stamps using time_parse function, which would create issues when users change their time zones. Calling time_zone_parse instead of time_parse solves the issue. This method also had massive duplicate code for different test scenarios. A helper method enqueue_scheduled_tasks(stage) is used to encapsulate the task being performed.
-After refactoring in scheduled_spec.rb:
+After refactoring in scheduled_spec.rb the majority of the test cases were written in less than five lines, with the exception of the team formation test which required additional logic but was still significantly compressed.
 '''Refactoring Assignment_creation_spec'''

Mdunlap at 21:54, 31 March 2017

2017-03-31T21:54:29Z

← Older revision		Revision as of 21:54, 31 March 2017
Line 11:		Line 11:
	'''Running Tests'''		'''Running Tests'''

	After building the Expertiza environment run 'rspec spec/features/*_spec.rb' to run all of the feature tests. This will run the feature spec test files. In order to fully test that the refactoring has worked the negative of the expect statements where tested to ensure that they failed and that the tests were still running as expected. Once the test failed as expected the tests were changed back to run to success.		After building the Expertiza environment run 'rspec spec/features/*_spec.rb' to run all of the feature tests. This will run the feature spec test files.

	'''Test Plan'''		'''Test Plan'''

	Since this is a refactoring of rspec tests, the testing will consist of running the tests as described in the previous section and ensuring that all of the tests pass. ~~To further~~		Since this is a refactoring of rspec tests, the testing will consist of running the tests as described in the previous section and ensuring that all of the tests pass. In order to fully test that the refactoring has worked the negative of the expect statements where tested to ensure that they failed and that the tests were still running as expected. Once the test failed as expected the tests were changed back to run to success.

	'''Refactoring Delayed_mailer Method'''		'''Refactoring Delayed_mailer Method'''

Mdunlap at 21:53, 31 March 2017

2017-03-31T21:53:28Z

← Older revision		Revision as of 21:53, 31 March 2017
Line 11:		Line 11:
	'''Running Tests'''		'''Running Tests'''

	After building the Expertiza environment run 'rspec spec/features/*_spec.rb' to run all of the feature tests. This will run the feature spec test files.		After building the Expertiza environment run 'rspec spec/features/*_spec.rb' to run all of the feature tests. This will run the feature spec test files. In order to fully test that the refactoring has worked the negative of the expect statements where tested to ensure that they failed and that the tests were still running as expected. Once the test failed as expected the tests were changed back to run to success.

	'''Test Plan'''		'''Test Plan'''

	Since this is a refactoring of rspec tests, the testing will consist of running the tests as described in the previous section and ensuring that all of the tests pass.		Since this is a refactoring of rspec tests, the testing will consist of running the tests as described in the previous section and ensuring that all of the tests pass. To further

	'''Refactoring Delayed_mailer Method'''		'''Refactoring Delayed_mailer Method'''

Mdunlap at 21:50, 27 March 2017

2017-03-27T21:50:35Z

← Older revision		Revision as of 21:50, 27 March 2017
Line 12:		Line 12:

	After building the Expertiza environment run 'rspec spec/features/*_spec.rb' to run all of the feature tests. This will run the feature spec test files.		After building the Expertiza environment run 'rspec spec/features/*_spec.rb' to run all of the feature tests. This will run the feature spec test files.

			'''Test Plan'''

			Since this is a refactoring of rspec tests, the testing will consist of running the tests as described in the previous section and ensuring that all of the tests pass.

	'''Refactoring Delayed_mailer Method'''		'''Refactoring Delayed_mailer Method'''

Mdunlap at 23:43, 26 March 2017

2017-03-26T23:43:16Z

← Older revision		Revision as of 23:43, 26 March 2017
Line 8:		Line 8:

	Remove duplicated code in feature tests and improve the overall Code Climate. Code Climate aides in determining the DRYness and style of code, more information can be found at https://codeclimate.com/dashboard.		Remove duplicated code in feature tests and improve the overall Code Climate. Code Climate aides in determining the DRYness and style of code, more information can be found at https://codeclimate.com/dashboard.


	'''Running Tests'''		'''Running Tests'''

Mdunlap at 23:43, 26 March 2017

2017-03-26T23:43:01Z

← Older revision		Revision as of 23:43, 26 March 2017
Line 7:		Line 7:
	'''Problem Statement'''		'''Problem Statement'''

	Remove duplicated code in feature tests and improve the overall Code Climate.		Remove duplicated code in feature tests and improve the overall Code Climate. Code Climate aides in determining the DRYness and style of code, more information can be found at https://codeclimate.com/dashboard.


			'''Running Tests'''

			After building the Expertiza environment run 'rspec spec/features/*_spec.rb' to run all of the feature tests. This will run the feature spec test files.

	'''Refactoring Delayed_mailer Method'''		'''Refactoring Delayed_mailer Method'''

Remcelfr at 00:51, 24 March 2017

2017-03-24T00:51:03Z

@@ Line 50: / Line 50: @@
 Assignment_creation_spec covers testing scenarios that create public and private assignments as well as the various options in this assignment creation.
-This using CodeClimate it was identified that a large portion of the code was duplicated across multiple test cases which violates the DRY principle. The redundant code was generalized and placed in methods instead of being written in each of the test cases and redundant methods that were never called were removed from class.
+Using CodeClimate it was identified that a large portion of the code was duplicated across multiple test cases which violates the DRY principle. The redundant code was generalized and placed in methods instead of being written in each of the test cases and redundant methods that were never called were removed from class.
 The code below is a sample of the refactored code where instead of having redundant code, handle_questionaire is called with a few parameters and all of the redundant code in the test cases is replaced.
@@ Line 94: / Line 94: @@
 Instructor_interface_spec covers testing scenarios like creating a course, importing tests, and viewing publishing rights.
 Unlike assignment_creation_spec, the largest violation (as determined by CodeClimate) of the DRY principle was functionality that was exactly duplicated in questionnaire_spec. In order to fix this /spec/helpers/instructor_interface_helper_spec was created as a module and then included in both of the other Ruby files as a mixin.

Mdunlap at 23:34, 23 March 2017

2017-03-23T23:34:21Z

← Older revision		Revision as of 23:34, 23 March 2017
Line 93:		Line 93:

	Instructor_interface_spec covers testing scenarios like creating a course, importing tests, and viewing publishing rights.		Instructor_interface_spec covers testing scenarios like creating a course, importing tests, and viewing publishing rights.
	Unlike assignment_creation_spec, the largest violation (as determined by CodeClimate) of the DRY principle was functionality that was duplicated in questionnaire_spec. In order to fix this /spec/helpers/instructor_interface_helper_spec was created as a module and then included in both of the other Ruby files as a mixin.		Unlike assignment_creation_spec, the largest violation (as determined by CodeClimate) of the DRY principle was functionality that was exactly duplicated in questionnaire_spec. In order to fix this /spec/helpers/instructor_interface_helper_spec was created as a module and then included in both of the other Ruby files as a mixin.

Mdunlap at 23:33, 23 March 2017

2017-03-23T23:33:19Z

← Older revision		Revision as of 23:33, 23 March 2017
Line 54:		Line 54:
	The code below is a sample of the refactored code where instead of having redundant code, handle_questionaire is called with a few parameters and all of the redundant code in the test cases is replaced.		The code below is a sample of the refactored code where instead of having redundant code, handle_questionaire is called with a few parameters and all of the redundant code in the test cases is replaced.

	def validate_attributes(questionaire_name)		def validate_attributes(questionaire_name)
	questionnaire = get_questionnaire(questionaire_name).first		questionnaire = get_questionnaire(questionaire_name).first
	expect(questionnaire).to have_attributes(		expect(questionnaire).to have_attributes(
	questionnaire_weight: 50,		questionnaire_weight: 50,
	notification_limit: 50		notification_limit: 50
	)		)
	end		end

	def validate_dropdown		def validate_dropdown
	questionnaire = Questionnaire.where(name: "ReviewQuestionnaire2").first		questionnaire = Questionnaire.where(name: "ReviewQuestionnaire2").first
	assignment_questionnaire = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).first		assignment_questionnaire = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).first
	expect(assignment_questionnaire.dropdown).to eq(false)		expect(assignment_questionnaire.dropdown).to eq(false)
	end		end

	def fill_in_questionaire(questionaire_css, questionaire_name)		def fill_in_questionaire(questionaire_css, questionaire_name)
	within(:css, questionaire_css) do		within(:css, questionaire_css) do
	select questionaire_name, from: 'assignment_form[assignment_questionnaire][][questionnaire_id]'		select questionaire_name, from: 'assignment_form[assignment_questionnaire][][questionnaire_id]'
	uncheck('dropdown')		uncheck('dropdown')
	select "Scale", from: 'assignment_form[assignment_questionnaire][][dropdown]'		select "Scale", from: 'assignment_form[assignment_questionnaire][][dropdown]'
	fill_in 'assignment_form[assignment_questionnaire][][questionnaire_weight]', with: '50'		fill_in 'assignment_form[assignment_questionnaire][][questionnaire_weight]', with: '50'
	fill_in 'assignment_form[assignment_questionnaire][][notification_limit]', with: '50'		fill_in 'assignment_form[assignment_questionnaire][][notification_limit]', with: '50'
			end
			click_button 'Save'
			sleep 1
	end		end
	~~click_button 'Save'~~
	~~sleep 1~~
	~~end~~

	def handle_questionaire(questionaire_css, questionaire_name, test_attributes)		def handle_questionaire(questionaire_css, questionaire_name, test_attributes)
	fill_in_questionaire(questionaire_css, questionaire_name)		fill_in_questionaire(questionaire_css, questionaire_name)
	if test_attributes		if test_attributes
	validate_attributes(questionaire_name)		validate_attributes(questionaire_name)
	else		else
	~~validate_dropdown~~		validate_dropdown
			end
	end		end
	~~end~~

Mdunlap at 23:31, 23 March 2017

2017-03-23T23:31:41Z

← Older revision		Revision as of 23:31, 23 March 2017
Line 46:		Line 46:
	end		end
	end		end

			'''Refactoring Assignment_creation_spec'''

			Assignment_creation_spec covers testing scenarios that create public and private assignments as well as the various options in this assignment creation.
			This using CodeClimate it was identified that a large portion of the code was duplicated across multiple test cases which violates the DRY principle. The redundant code was generalized and placed in methods instead of being written in each of the test cases and redundant methods that were never called were removed from class.

			The code below is a sample of the refactored code where instead of having redundant code, handle_questionaire is called with a few parameters and all of the redundant code in the test cases is replaced.

			def validate_attributes(questionaire_name)
			questionnaire = get_questionnaire(questionaire_name).first
			expect(questionnaire).to have_attributes(
			questionnaire_weight: 50,
			notification_limit: 50
			)
			end

			def validate_dropdown
			questionnaire = Questionnaire.where(name: "ReviewQuestionnaire2").first
			assignment_questionnaire = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).first
			expect(assignment_questionnaire.dropdown).to eq(false)
			end

			def fill_in_questionaire(questionaire_css, questionaire_name)
			within(:css, questionaire_css) do
			select questionaire_name, from: 'assignment_form[assignment_questionnaire][][questionnaire_id]'
			uncheck('dropdown')
			select "Scale", from: 'assignment_form[assignment_questionnaire][][dropdown]'
			fill_in 'assignment_form[assignment_questionnaire][][questionnaire_weight]', with: '50'
			fill_in 'assignment_form[assignment_questionnaire][][notification_limit]', with: '50'
			end
			click_button 'Save'
			sleep 1
			end

			def handle_questionaire(questionaire_css, questionaire_name, test_attributes)
			fill_in_questionaire(questionaire_css, questionaire_name)
			if test_attributes
			validate_attributes(questionaire_name)
			else
			validate_dropdown
			end
			end


			'''Refactoring Instructor_interface_spec'''

			Instructor_interface_spec covers testing scenarios like creating a course, importing tests, and viewing publishing rights.
			Unlike assignment_creation_spec, the largest violation (as determined by CodeClimate) of the DRY principle was functionality that was duplicated in questionnaire_spec. In order to fix this /spec/helpers/instructor_interface_helper_spec was created as a module and then included in both of the other Ruby files as a mixin.