CSC/ECE 517 Spring 2020 Refactor assignment.rb - Revision history

Ahubber: /* Testing */

2020-04-01T00:59:36Z

Testing

← Older revision		Revision as of 00:59, 1 April 2020
Line 38:		Line 38:
	== [[Testing]] ==		== [[Testing]] ==

	For testing, assignment.rb was already tested pretty well. According to Code Climate it had a B grade for test coverage. Thus the testing effort for this project was not heavy, but we did want to be sure that none of our changes broke any existing tests, and all of our additional methods were tested. For example, one new method we added was:		For testing, assignment.rb was already tested pretty well. According to Code Climate it had a B grade for test coverage. Thus the testing effort for this project was not heavy, but we did want to be sure that none of our changes broke any existing tests, and all of our additional methods were tested. Also there was a method response_map_to_metareview which was not being tested in case of an error, so I added a test case to be sure the exception was raised. For example, one new method we added was:

	# New function to check if the assignment is finished		# New function to check if the assignment is finished
Line 62:		Line 62:
	end		end
	end		end

	~~Also there was a method response_map_to_metareview which was not being tested in case of an error, so I added a test case to be sure the exception was raised.~~

2020-04-01T00:25:45Z

Testing

← Older revision		Revision as of 00:25, 1 April 2020
Line 45:		Line 45:
	end		end

	For this method we ~~addes~~ a few tests to validate the method was returning the values we expect.		For this method we added a few tests to validate the method was returning the values we expect.

	describe '#finished?' do		describe '#finished?' do
Line 62:		Line 62:
	end		end
	end		end

			Also there was a method response_map_to_metareview which was not being tested in case of an error, so I added a test case to be sure the exception was raised.

2020-03-31T16:28:57Z

Testing

← Older revision		Revision as of 16:28, 31 March 2020
Line 47:		Line 47:
	For this method we addes a few tests to validate the method was returning the values we expect.		For this method we addes a few tests to validate the method was returning the values we expect.

	describe '#finished?' do		describe '#finished?' do
	context 'when assignment next due date is nil' do		context 'when assignment next due date is nil' do
	it 'returns True' do		it 'returns True' do

2020-03-31T16:28:27Z

Testing

← Older revision		Revision as of 16:28, 31 March 2020
Line 37:		Line 37:

	== [[Testing]] ==		== [[Testing]] ==

			For testing, assignment.rb was already tested pretty well. According to Code Climate it had a B grade for test coverage. Thus the testing effort for this project was not heavy, but we did want to be sure that none of our changes broke any existing tests, and all of our additional methods were tested. For example, one new method we added was:

			# New function to check if the assignment is finished
			def finished?(topic_id = nil)
			next_due_date(topic_id).nil?
			end

			For this method we addes a few tests to validate the method was returning the values we expect.

			describe '#finished?' do
			context 'when assignment next due date is nil' do
			it 'returns True' do
			allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
			expect(assignment.finished?(123)).to eq(true)
			end
			end

			context 'when there is a next due date' do
			it 'returns False' do
			allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
			expect(assignment.finished?(123)).to eq(false)
			end
			end
			end

2020-03-30T22:19:54Z

Refactors

← Older revision		Revision as of 22:19, 30 March 2020
Line 15:		Line 15:
	== [[Refactors]] ==		== [[Refactors]] ==

	One of the main issues I saw in the code was the reuse of string literals in comparisons. These would cause hige efforts to change later if there are hundreds of places where these strings are used. Instead I replaced all instances of these strings in the file with constants, to lower complexity.		- One of the main issues I saw in the code was the reuse of string literals in comparisons. These would cause hige efforts to change later if there are hundreds of places where these strings are used. Instead I replaced all instances of these strings in the file with constants, to lower complexity.

	Added these constants to file:		Added these constants to file:
Line 29:		Line 29:


	The next issue I found was in multiple places where the code was making the same boolean checks. Instead rewtiting tge checks each time I made a method to return True/False for the check.		- The next issue I found was in multiple places where the code was making the same boolean checks. Instead rewtiting tge checks each time I made a method to return True/False for the check.

	# Function to check if topic id is null when its a staggered assignment, to prevent redundancy		# Function to check if topic id is null when its a staggered assignment, to prevent redundancy

2020-03-30T22:17:14Z

Refactors

← Older revision		Revision as of 22:17, 30 March 2020
Line 27:		Line 27:
	due_date == FINISHED_CONST		due_date == FINISHED_CONST
	return (topic_id.nil? ? UNKNOWN_CONST : get_current_stage(topic_id))		return (topic_id.nil? ? UNKNOWN_CONST : get_current_stage(topic_id))


			The next issue I found was in multiple places where the code was making the same boolean checks. Instead rewtiting tge checks each time I made a method to return True/False for the check.

			# Function to check if topic id is null when its a staggered assignment, to prevent redundancy
			def topic_missing?(topic_id = nil)
			topic_id.nil? and self.staggered_deadline?
			end

	== [[Testing]] ==		== [[Testing]] ==

2020-03-30T22:16:06Z

Refactors

← Older revision		Revision as of 22:16, 30 March 2020
Line 14:		Line 14:

	== [[Refactors]] ==		== [[Refactors]] ==

			One of the main issues I saw in the code was the reuse of string literals in comparisons. These would cause hige efforts to change later if there are hundreds of places where these strings are used. Instead I replaced all instances of these strings in the file with constants, to lower complexity.

	Added these constants to file:		Added these constants to file:

2020-03-30T22:14:22Z

Problem Solution

← Older revision		Revision as of 22:14, 30 March 2020
Line 12:		Line 12:

	Due to the fragile nature of the methods in Assignment.rb, our team decided to focus on redundancy in the code and anywhere we could merge redundant code into common methods. Also there were quite a few strings that were used constantly in the file, ie. 'Finished' that we decided to make constants, to reduce complexity if the values ever changed.		Due to the fragile nature of the methods in Assignment.rb, our team decided to focus on redundancy in the code and anywhere we could merge redundant code into common methods. Also there were quite a few strings that were used constantly in the file, ie. 'Finished' that we decided to make constants, to reduce complexity if the values ever changed.


	== [[Refactors]] ==		== [[Refactors]] ==

2020-03-30T21:05:09Z

Refactors

← Older revision		Revision as of 21:05, 30 March 2020
Line 21:		Line 21:
	FINISHED_CONST = 'Finished'.freeze		FINISHED_CONST = 'Finished'.freeze
	UNKNOWN_CONST = 'Unknown'.freeze		UNKNOWN_CONST = 'Unknown'.freeze

			Removed references to string literals and made constant values

	due_date == FINISHED_CONST		due_date == FINISHED_CONST

2020-03-30T21:04:20Z

Refactors

← Older revision		Revision as of 21:04, 30 March 2020
Line 22:		Line 22:
	UNKNOWN_CONST = 'Unknown'.freeze		UNKNOWN_CONST = 'Unknown'.freeze

			due_date == FINISHED_CONST
	(topic_id.nil? ? UNKNOWN_CONST : get_current_stage(topic_id))		return (topic_id.nil? ? UNKNOWN_CONST : get_current_stage(topic_id))
	~~due_date == FINISHED_CONST~~

	== [[Testing]] ==		== [[Testing]] ==