CSC/ECE 517 Fall 2017/E1752 Refactor assignments controller - Revision history

Adeshmu: /* Testing results */

2017-11-02T20:47:16Z

Testing results

← Older revision		Revision as of 20:47, 2 November 2017
Line 26:		Line 26:

	===Testing results===		===Testing results===
	All 22 tests were passed with zero failure on the final version of project code.		All 22 tests were passed with zero failure on the final version of project code. Please refer to our detail project demo to see the testing in action.

	==About Refactoring==		==About Refactoring==

Adeshmu: /* Additional Links */

2017-11-02T20:45:38Z

Additional Links

← Older revision		Revision as of 20:45, 2 November 2017
Line 218:		Line 218:
	==Additional Links==		==Additional Links==
	[https://github.com/jerry-shijieli/expertiza Github project repo]<br>		[https://github.com/jerry-shijieli/expertiza Github project repo]<br>
	[https://www.youtube.com/playlist?list=PLUHiK0P0uQKLvW-_hBDdRK3x4cFn6BJ4C Project Video Demo]		[https://www.youtube.com/playlist?list=PLUHiK0P0uQKLvW-_hBDdRK3x4cFn6BJ4C Project Video Demo]<br>
	[https://github.com/expertiza/expertiza/pull/1024 Pull request]		[https://github.com/expertiza/expertiza/pull/1024 Pull request]

Adeshmu: /* Additional Links */

2017-11-02T20:45:22Z

Additional Links

← Older revision		Revision as of 20:45, 2 November 2017
Line 219:		Line 219:
	[https://github.com/jerry-shijieli/expertiza Github project repo]<br>		[https://github.com/jerry-shijieli/expertiza Github project repo]<br>
	[https://www.youtube.com/playlist?list=PLUHiK0P0uQKLvW-_hBDdRK3x4cFn6BJ4C Project Video Demo]		[https://www.youtube.com/playlist?list=PLUHiK0P0uQKLvW-_hBDdRK3x4cFn6BJ4C Project Video Demo]
			[https://github.com/expertiza/expertiza/pull/1024 Pull request]

	==References==		==References==

Sli41: change names of methods in edit and update

2017-10-30T00:52:04Z

change names of methods in edit and update

← Older revision		Revision as of 00:52, 30 October 2017
Line 117:		Line 117:
	<pre>		<pre>
	def edit		def edit
	~~current_user_timezonepref_nil_message~~		handle_current_user_timezonepref_nil

	edit_params_setting		edit_params_setting
Line 124:		Line 124:

	@due_date_all.each do \|dd\|		@due_date_all.each do \|dd\|
	~~due_date_nameurl_notempty_check~~(dd)		check_due_date_nameurl_notempty(dd)

	~~due_date_present~~(dd)		adjust_timezone_when_due_date_present(dd)

	break if ~~due_date_validation~~		break if validate_due_date
	end		end

	~~assignment_questionnaires_usage_check~~		check_assignment_questionnaires_usage

	@due_date_all = update_nil_dd_deadline_name(@due_date_all)		@due_date_all = update_nil_dd_deadline_name(@due_date_all)
Line 137:		Line 137:

	# only when instructor does not assign rubrics and in assignment edit page will show this error message.		# only when instructor does not assign rubrics and in assignment edit page will show this error message.
	~~rubrics_not_assigned_message~~		handle_rubrics_not_assigned_case

	~~assignment_directory_path_nonexist_message~~		handle_assignment_directory_path_nonexist_case
	end		end
	</pre>		</pre>
Line 192:		Line 192:
	end		end

	~~assignment_form_retrieval~~		retrieve_assignment_form

	~~current_user_timezonepref_nil_handler~~		handle_current_user_timezonepref_nil

	~~assignment_form_update_attributes_message~~		feedback_assignment_form_attributes_update

	redirect_to edit_assignment_path @assignment_form.assignment.id		redirect_to edit_assignment_path @assignment_form.assignment.id

Sli41: reorganize section title

2017-10-28T02:39:28Z

reorganize section title

← Older revision		Revision as of 02:39, 28 October 2017
Line 24:		Line 24:
	* Creating new tests for each method,		* Creating new tests for each method,
	* Testing the each method and making sure the tests pass.		* Testing the each method and making sure the tests pass.

			===Testing results===
			All 22 tests were passed with zero failure on the final version of project code.

	==About Refactoring==		==About Refactoring==
Line 35:		Line 38:
	* Rename existing methods with meaningful names for better readability without change on external functionality.		* Rename existing methods with meaningful names for better readability without change on external functionality.

	====Refactor edit method: code block split, method extraction and ~~new~~ constants~~====~~		===Refactor edit method===
			Actions: code block split, method extraction and add meaningful constants

	Original		Original
Line 140:		Line 144:
	Here we first grouped the blocks of code according to their similarity of functions. Then we extracted simpler methods from each code block to make it more readable and reduce the complexity and coupling. It is obvious that after refactoring, this part is simpler and easier to maintain. In addition, we also replaced the magic numbers by constants according to the deadline type.		Here we first grouped the blocks of code according to their similarity of functions. Then we extracted simpler methods from each code block to make it more readable and reduce the complexity and coupling. It is obvious that after refactoring, this part is simpler and easier to maintain. In addition, we also replaced the magic numbers by constants according to the deadline type.

	====Refactor update method: split long code block and extract specific methods~~====~~		===Refactor update method===
			Actions: split long code block and extract specific methods

	Original		Original
Line 198:		Line 203:
	The update method was refactored in the similar way to reduce the size of codes and improve readability. The definitions of those helper methods were placed at the bottom of the assignments_controller.rb.		The update method was refactored in the similar way to reduce the size of codes and improve readability. The definitions of those helper methods were placed at the bottom of the assignments_controller.rb.

	====Rename existing helper methods: consistent ~~with~~ Ruby code style~~====~~		===Rename existing helper methods===
			Actions: rename for consistent Ruby code style

	<pre>		<pre>
	is_due_date_nameurl_notempty → due_date_nameurl_notempty?		is_due_date_nameurl_notempty → due_date_nameurl_notempty?

Sli41: add details about edit, update refactoring and helper method renaming

2017-10-28T02:31:31Z

add details about edit, update refactoring and helper method renaming

Show changes

Sli41: add constant part

2017-10-28T01:17:24Z

add constant part

← Older revision		Revision as of 01:17, 28 October 2017
Line 19:		Line 19:
	RSpec is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring.		RSpec is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring.

	The Expertiza project makes extensive use of RSpec to test the various components of the application.		The Expertiza project makes extensive use of RSpec to test the various components of the application. Tests of our tasks are in the code file: spec/controllers/assignments_controller_spec.rb

	===Testing actions perfomed===		===Testing actions perfomed===
Line 29:		Line 29:

	===Refactoring actions perfomed===		===Refactoring actions perfomed===
			* Replace magic numbers in deadline_type_id by constants with reasonable names;
	* Formatting the code for readability and convention;		* Formatting the code for readability and convention;
	* Split large chunks of code in to smaller manageable chunks;		* Split large chunks of code in to smaller manageable chunks;
Line 63:		Line 64:
	end		end

	It is obvious that after refactoring, this part is simpler and easier to maintain. After each refactoring procedure, we perform the testing to ensure the expected functionality in Rspec. For more cases, please check our GitHub project repo.		It is obvious that after refactoring, this part is simpler and easier to maintain. After each refactoring procedure, we perform the testing to ensure the expected functionality in Rspec. For more cases, please check our GitHub project repo. The files we make change on are: app/controllers/assignments_controller.rb and app/helpers/deadline_helper.rb

	==Additional Links==		==Additional Links==

Sli41: update refactor

2017-10-28T00:05:43Z

update refactor

← Older revision		Revision as of 00:05, 28 October 2017
Line 63:		Line 63:
	end		end

	It is obvious that after refactoring, this part is simpler and easier to maintain. After each refactoring procedure, we perform the testing to ensure the expected functionality in Rspec.		It is obvious that after refactoring, this part is simpler and easier to maintain. After each refactoring procedure, we perform the testing to ensure the expected functionality in Rspec. For more cases, please check our GitHub project repo.

	==Additional Links==		==Additional Links==

Sli41: add example to refactoring

2017-10-28T00:04:21Z

add example to refactoring

← Older revision		Revision as of 00:04, 28 October 2017
Line 6:		Line 6:

	==About Software Testing==		==About Software Testing==
	Software testing is a process of examining a program or application with the intent of finding the software bugs. In software developemnt, it is usually ~~definated~~ as the process of validating and verifying that a software program or application or product meets the specified business and technical requirements.		Software testing is a process of examining a program or application with the intent of finding the software bugs. In software developemnt, it is usually defined as the process of validating and verifying that a software program or application or product meets the specified business and technical requirements.

	Additionaly, software is tested to:		Additionaly, software is tested to:
Line 12:		Line 12:
	* Ensure customer satisfaction in the application,		* Ensure customer satisfaction in the application,
	* Ensure the quality of the software product and		* Ensure the quality of the software product and
	* Optimize the performance of the system,		* Optimize the performance of the system.

			Our project is guided by the Test-First Development principle. We write passing and failing tests for use cases of the assignment controller, and then turn to refactor the code. During the project, we implement the tests and refactor in Agile methodology with our mentor Zhewei through weekly delivery.

	===RSpec Testing===		===RSpec Testing===
Line 28:		Line 30:
	===Refactoring actions perfomed===		===Refactoring actions perfomed===
	* Formatting the code for readability and convention;		* Formatting the code for readability and convention;
	* ~~Breaking down~~ large chunks of code in to smaller manageable chunks;		* Split large chunks of code in to smaller manageable chunks;
	* Extract methods out of blocks of codes to remove code duplications using DRY principle;		* Extract simpler and specific methods out of blocks of codes to remove code duplications using DRY principle;
	* Rename existing methods with meaningful names for better readability without change on external functionality.		* Rename existing methods with meaningful names for better readability without change on external functionality.

	After each refactoring procedure, we perform the testing to ensure the expected functionality in Rspec.		Example: code block split and method extraction

			Original

			@due_date_nameurl_notempty = is_due_date_nameurl_notempty(dd)
			@due_date_nameurl_notempty_checkbox = @due_date_nameurl_notempty
			@metareview_allowed = is_meta_review_allowed?(dd)
			@drop_topic_allowed = is_drop_topic_allowed?(dd)
			@signup_allowed = is_signup_allowed?(dd)
			@team_formation_allowed = is_team_formation_allowed?(dd)
			if dd.due_at.present?
			dd.due_at = dd.due_at.to_s.in_time_zone(current_user.timezonepref)
			end
			if @due_date_nameurl_notempty && @due_date_nameurl_notempty_checkbox &&
			(@metareview_allowed \|\| @drop_topic_allowed \|\| @signup_allowed \|\| @team_formation_allowed)
			break
			end


			After refactoring

			due_date_nameurl_notempty_check(dd)

			due_date_present(dd)

			if due_date_validation
			break
			end

			It is obvious that after refactoring, this part is simpler and easier to maintain. After each refactoring procedure, we perform the testing to ensure the expected functionality in Rspec.

	==Additional Links==		==Additional Links==

Sli41: add details about assignment controller

2017-10-27T23:38:48Z

add details about assignment controller

← Older revision		Revision as of 23:38, 27 October 2017
Line 3:		Line 3:

	==About Assignments Controller==		==About Assignments Controller==
	The file assignments_controller.rb handles the logic behind Expertiza assignments and enables the creation and managements of assignments by instructional staff.		The file assignments_controller.rb handles the logic behind Expertiza assignments and enables the creation and managements of assignments by instructional staff. Besides regular CRUD operations, it also integrates multiple parts of the expertiza components, such as users of different authorizations and priorities, corresponding courses associated with the assignment, due date and so on. Therefore, further unit and integration tests are required to guarantee that these operations work as expected. And also refactoring on the code in this controller is needed to make it more readable and reduce the complexity at the same time. Our tasks are based on the motivations above.

	==About Software Testing==		==About Software Testing==
Line 31:		Line 31:
	* Extract methods out of blocks of codes to remove code duplications using DRY principle;		* Extract methods out of blocks of codes to remove code duplications using DRY principle;
	* Rename existing methods with meaningful names for better readability without change on external functionality.		* Rename existing methods with meaningful names for better readability without change on external functionality.

			After each refactoring procedure, we perform the testing to ensure the expected functionality in Rspec.

	==Additional Links==		==Additional Links==