CSC/ECE 517 Fall 2015/oss E1553 AAJ - Revision history

Mguo6: Undo revision 139210 by Mguo6 (talk)

2021-10-20T00:15:51Z

Undo revision 139210 by Mguo6 (talk)

← Older revision		Revision as of 00:15, 20 October 2021
Line 14:		Line 14:
	The following tasks were accomplished in this project:		The following tasks were accomplished in this project:

	* ~~Line 76~~ and ~~77: use more Ruby-like String concepts~~		* Improved the clarity of code by improving the variable and parameter names.
	* ~~Line 94: Refactor create_new_team to assignment_team~~.rb		* Long character strings were taken and given appropriate names.
	* ~~Line 125: Refactor notification to simplify control logic~~.		* Handled pagination by a separate helper module, which can be used by multiple controllers.
	* ~~Line 160: Refactor approve_suggestion~~ to ~~indicate that notification is being sent~~.		* Implemented action_allowed for access_control to prevent unauthorized access of methods.
	* ~~Test functions~~ and ~~increase coverage:~~		* Prevented displaying of all versions for all users and tables when a user views the index page.
	** Check error in approve		* Added missing CRUD methods to Versions Controller
	** Test reject_suggestion		* Added RSPEC testcases for testing changes done in Versions Controller
	** Test when ~~topic_id.nil? to make sure~~ the ~~waitlist is cleared~~.
	**~~Test the submit, student_view, student_edit, update_suggestion, add_comment function~~


	===About Versions Controller===		===About Versions Controller===

Mguo6 at 22:32, 19 October 2021

2021-10-19T22:32:27Z

← Older revision		Revision as of 22:32, 19 October 2021
Line 14:		Line 14:
	The following tasks were accomplished in this project:		The following tasks were accomplished in this project:

	* ~~Improved the clarity of code by improving the variable~~ and ~~parameter names.~~		* Line 76 and 77: use more Ruby-like String concepts
	* ~~Long character strings were taken and given appropriate names~~.		* Line 94: Refactor create_new_team to assignment_team.rb
	* ~~Handled pagination by a separate helper module, which can be used by multiple controllers~~.		* Line 125: Refactor notification to simplify control logic.
	* ~~Implemented action_allowed for access_control~~ to ~~prevent unauthorized access of methods~~.		* Line 160: Refactor approve_suggestion to indicate that notification is being sent.
	* ~~Prevented displaying of all versions for all users~~ and ~~tables~~ when ~~a user views~~ the ~~index page~~.		* Test functions and increase coverage:
	* ~~Added missing CRUD methods to Versions Controller~~		** Check error in approve
	* Added RSPEC testcases for testing changes done in Versions Controller		** Test reject_suggestion
			** Test when topic_id.nil? to make sure the waitlist is cleared.
			**Test the submit, student_view, student_edit, update_suggestion, add_comment function


	===About Versions Controller===		===About Versions Controller===

Prtanksa: /* About Expertiza*/

2016-10-28T15:23:56Z

About Expertiza

← Older revision		Revision as of 15:23, 28 October 2016
Line 7:		Line 7:


	===~~Problem Statement~~===		===About Expertiza===

	[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.		[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Prtanksa: /* About Versions Controller */

2016-10-28T14:57:28Z

About Versions Controller

← Older revision		Revision as of 14:57, 28 October 2016
Line 24:		Line 24:
	===About Versions Controller===		===About Versions Controller===
	This class manages different versions of reviews. If a reviewer reviews a submission, and after that, the author revises the submission, the next time the reviewer does a review (s)he will create a new version. Sometimes it’s necessary to find the current version of a review; sometimes it’s necessary to find all versions. Similarly, a user may want to delete the current version of a review, or all versions of a review. Pagination of versions helps the user to view a subset of versions at a time. Considering the huge number of versions in the system, it is very useful to have a pagination mechanism and a filtering mechanism which can be applied on the whole set of versions. The idea is to display the versions in an ordered, comprehensible and logical manner. In Expertiza the gem ‘will_paginate’ is used to achieve pagination.		This class manages different versions of reviews. If a reviewer reviews a submission, and after that, the author revises the submission, the next time the reviewer does a review (s)he will create a new version. Sometimes it’s necessary to find the current version of a review; sometimes it’s necessary to find all versions. Similarly, a user may want to delete the current version of a review, or all versions of a review. Pagination of versions helps the user to view a subset of versions at a time. Considering the huge number of versions in the system, it is very useful to have a pagination mechanism and a filtering mechanism which can be applied on the whole set of versions. The idea is to display the versions in an ordered, comprehensible and logical manner. In Expertiza the gem ‘will_paginate’ is used to achieve pagination.

	* questionnaires_controller.rb


	===Current Implementation===		===Current Implementation===

Prtanksa: /* E1553. Refactoring the Versions Controller */

2016-10-28T14:57:09Z

E1553. Refactoring the Versions Controller

← Older revision		Revision as of 14:57, 28 October 2016
Line 1:		Line 1:
	==~~E1653~~. ~~Fix and improve rubric criteria~~==		==E1553. Refactoring the Versions Controller==

	This page provides a description of the Expertiza based OSS project.		This page provides a description of the Expertiza based OSS project.
Line 7:		Line 7:


	===~~Introduction to Expertiza~~===		===Problem Statement===

	[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.		[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

	===~~Tasks Identified~~===		===Problem Statement===
			The following tasks were accomplished in this project:

	* ~~Change allow_action? method~~ of ~~questionnaires controller~~ to ~~restrict~~ unauthorized access ~~to edit rubrics. Only Instructors who own the rubric or their Teaching Assistants should be allowed edit them~~.		* Improved the clarity of code by improving the variable and parameter names.
	* ~~Redirect~~ a user ~~who is not the owner of the rubric which he attempts to edit to~~ the ~~corresponding view~~ page ~~of the rubric~~.		* Long character strings were taken and given appropriate names.
			* Handled pagination by a separate helper module, which can be used by multiple controllers.
			* Implemented action_allowed for access_control to prevent unauthorized access of methods.
			* Prevented displaying of all versions for all users and tables when a user views the index page.
			* Added missing CRUD methods to Versions Controller
			* Added RSPEC testcases for testing changes done in Versions Controller

			===About Versions Controller===
	===~~Modified Files~~===		This class manages different versions of reviews. If a reviewer reviews a submission, and after that, the author revises the submission, the next time the reviewer does a review (s)he will create a new version. Sometimes it’s necessary to find the current version of a review; sometimes it’s necessary to find all versions. Similarly, a user may want to delete the current version of a review, or all versions of a review. Pagination of versions helps the user to view a subset of versions at a time. Considering the huge number of versions in the system, it is very useful to have a pagination mechanism and a filtering mechanism which can be applied on the whole set of versions. The idea is to display the versions in an ordered, comprehensible and logical manner. In Expertiza the gem ‘will_paginate’ is used to achieve pagination.

	* questionnaires_controller.rb		* questionnaires_controller.rb

Prtanksa: /* E1653. Fix and improve rubric criteria*/

2016-10-27T22:24:36Z

E1653. Fix and improve rubric criteria

← Older revision		Revision as of 22:24, 27 October 2016
Line 1:		Line 1:
	==~~E1553~~. ~~Refactoring the Versions Controller~~==		==E1653. Fix and improve rubric criteria==

	This page provides a description of the Expertiza based OSS project.		This page provides a description of the Expertiza based OSS project.
Line 11:		Line 11:
	[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.		[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

	===~~Problem Statement~~===		===Tasks Identified===
	~~The following tasks were accomplished in this project:~~

	* ~~Improved the clarity~~ of ~~code by improving the variable and parameter names.~~		* Change allow_action? method of questionnaires controller to restrict unauthorized access to edit rubrics. Only Instructors who own the rubric or their Teaching Assistants should be allowed edit them.
	* Long character strings were taken and given appropriate names.		* Redirect a user who is not the owner of the rubric which he attempts to edit to the corresponding view page of the rubric.
	* Handled pagination by a separate helper module, which can be used by multiple controllers.
	* Implemented action_allowed for access_control to ~~prevent~~ unauthorized access ~~of methods~~.
	* ~~Prevented displaying of all versions for all users and tables when~~ a user ~~views~~ the ~~index~~ page.		===Modified Files===
	* Added missing CRUD methods to Versions Controller
	* ~~Added RSPEC testcases for testing changes done in Versions Controller~~		* questionnaires_controller.rb

	~~===About Versions Controller===~~
	This class manages different versions of reviews. If a reviewer reviews a submission, and after that, the author revises the submission, the next time the reviewer does a review (s)he will create a new version. Sometimes it’s necessary to find the current version of a review; sometimes it’s necessary to find all versions. Similarly, a user may want to delete the current version of a review, or all versions of a review.
	Pagination of versions helps the user to view a subset of versions at a time. Considering the huge number of versions in the system, it is very useful to have a pagination mechanism and a filtering mechanism which can be applied on the whole set of versions. The idea is to display the versions in an ordered, comprehensible and logical manner. In Expertiza the gem ‘will_paginate’ is used to achieve pagination.

	===Current Implementation===		===Current Implementation===

Apandey5 at 06:32, 2 November 2015

2015-11-02T06:32:44Z

@@ Line 190: / Line 190: @@
+.
 </pre>
 ===References===

Apandey5 at 22:06, 31 October 2015

2015-10-31T22:06:18Z

← Older revision		Revision as of 22:06, 31 October 2015
Line 177:		Line 177:

	===Automated Testing using RSPEC===		===Automated Testing using RSPEC===
			The current version of expertiza did not have any test for VersionsController. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for VersionsController, to test all the modifications we have done to the code of the controller class. The tests use double and stub features of rspec-rails gem, to fake the log in by different users - Administrator, Instructor, Student etc. The tests can be executed "rpec spec" command as shown below.
			<pre>
			user-expertiza $rspec spec
			.
			.
			.
			Finished in 5.39 seconds (files took 25.33 seconds to load)
			66 examples, 0 failures

			Randomized with seed 19254
			.
			.
			</pre>

	===References===		===References===

Asayal: /* References */

2015-10-31T16:12:47Z

References

← Older revision		Revision as of 16:12, 31 October 2015
Line 186:		Line 186:
	#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]		#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
	#[https://relishapp.com/rspec Rspec Documentation]		#[https://relishapp.com/rspec Rspec Documentation]
			#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

Asayal: /* Introduction to Expertiza */

2015-10-31T04:55:37Z

Introduction to Expertiza

← Older revision		Revision as of 04:55, 31 October 2015
Line 9:		Line 9:
	===Introduction to Expertiza===		===Introduction to Expertiza===

	[http://expertiza.ncsu.edu/ Expertiza] is ~~a large~~ project ~~developed as a combined effort of students and faculty using the~~ [http://rubyonrails.org/ Ruby on Rails] framework. ~~The main advantage of using~~ Expertiza~~, in an educational environment, is for~~ the instructor to ~~introduce peer reviewing among the students~~. ~~Expertiza~~ allows the instructor to ~~create and customize assignments,~~ create a list of topics the students can sign up for~~, have students~~ work on ~~teams~~ and ~~then~~ review ~~each~~ other'~~s assignments at the end~~. Expertiza supports submission ~~of almost any~~ document ~~type~~, including the URLs and wiki pages. Expertiza is supported by National Science Foundation under Grant No. 0536558. Additional funding from the [http://www.ncsu.edu/ NCSU] [http://litre.ncsu.edu/ Learning in a Technology-Rich Environment] (LITRE) program, the NCSU [http://ofd.ncsu.edu/teaching-learning/ Faculty Center for Teaching and Learning], the NCSU [http://stem.ncsu.edu/ STEM] Initiative, and the Center for Advanced Computing and Communication.		[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

	===Problem Statement===		===Problem Statement===