E1826 Add student view for instructor - Revision history

Zmathew at 03:56, 10 November 2018

2018-11-10T03:56:08Z

← Older revision		Revision as of 03:56, 10 November 2018
Line 131:		Line 131:
	it "can display relevant menu items after login as an admin/instructor/TA", js: true do		it "can display relevant menu items after login as an admin/instructor/TA", js: true do
	create(:instructor)		create(:instructor)
			create(:role_of_student)
	login_as 'instructor6'		login_as 'instructor6'
	visit '/tree_display/list'		visit '/tree_display/list'
Line 147:		Line 148:
	it "can display relevant menu items when switching to student view", js: true do		it "can display relevant menu items when switching to student view", js: true do
	create(:instructor)		create(:instructor)
			create(:role_of_student)
	login_as 'instructor6'		login_as 'instructor6'
	visit '/tree_display/list'		visit '/tree_display/list'

Zmathew at 05:45, 30 October 2018

2018-10-30T05:45:23Z

← Older revision		Revision as of 05:45, 30 October 2018
Line 44:		Line 44:
	</pre>		</pre>

			=== expertiza/app/controllers/role_switch_controller.rb ===

			A new ''role_switch_controller.rb'' file has been added. This controller contains the actions to open/close student view.
			<pre>
	class RoleSwitchController < ApplicationController		class RoleSwitchController < ApplicationController
	# check to see if the current action is allowed		# check to see if the current action is allowed
Line 71:		Line 75:
	end		end
	end		end
			</pre>

	=== expertiza/config/routes.rb ===		=== expertiza/config/routes.rb ===

Zmathew: /* expertiza/config/role_[admin|super_admin|instructor].yml */

2018-10-30T05:37:31Z

expertiza/config/role_[admin|super_admin|instructor].yml

← Older revision		Revision as of 05:37, 30 October 2018
Line 87:		Line 87:
	=== expertiza/config/role_[admin\|super_admin\|instructor].yml ===		=== expertiza/config/role_[admin\|super_admin\|instructor].yml ===

	A new menu node with the below format is added under 'Manage...' node in the yml configuration files for admin, superadmin and instructor.		A new menu node with the below format is added under 'Manage...' node in the yml configuration files for admin, superadmin , teaching assistants and instructor.
	<pre>		<pre>
	73: &25 !ruby/object:Menu::Node		73: &25 !ruby/object:Menu::Node

Zmathew: /* expertiza/app/controllers/role_switch_controller.rb */

2018-10-30T05:34:03Z

expertiza/app/controllers/role_switch_controller.rb

← Older revision		Revision as of 05:34, 30 October 2018
Line 44:		Line 44:
	</pre>		</pre>

	~~=== expertiza/app/controllers/role_switch_controller.rb ===~~

	~~A new ''role_switch_controller.rb'' file has been added. This controller contains the actions to open/close student view.~~
	~~<pre>~~
	class RoleSwitchController < ApplicationController		class RoleSwitchController < ApplicationController
	# check to see if the current action is allowed		# check to see if the current action is allowed
	def action_allowed?		def action_allowed?
	~~# instructor,admin,superadmin is allowed to perform all the actions in~~
	~~# this controller~~
	['Super-Administrator',		['Super-Administrator',
	'Administrator',		'Administrator',
			'Teaching Assistant',
	'Instructor'].include? current_role_name		'Instructor'].include? current_role_name
	end		end
Line 71:		Line 66:
	def close_student_view		def close_student_view
	session.delete(:student_view)		session.delete(:student_view)
	role = session[:user].~~role~~		role = Role.find(session[:user].role_id)
	session[:menu] = role.cache[:menu]		session[:menu] = role.cache[:menu]
	redirect_to controller: 'tree_display', action: 'list'		redirect_to controller: 'tree_display', action: 'list'
	end		end
	end		end
	~~</pre>~~

	=== expertiza/config/routes.rb ===		=== expertiza/config/routes.rb ===

Zmathew: /* expertiza/app/views/shared/_navigation.html.erb */

2018-10-30T05:33:22Z

expertiza/app/views/shared/_navigation.html.erb

← Older revision		Revision as of 05:33, 30 October 2018
Line 33:		Line 33:
	This file is shared between all views and is responsible for rendering all the elements on the navigation bar including the menu items.		This file is shared between all views and is responsible for rendering all the elements on the navigation bar including the menu items.

	In order to switch between default view and student view, the following code was added. When in default view, the instructor is presented with a link, ''Open Student View'', to switch to student view and when in student view, the ''Close Student View'' link can be used to switch back to the default view.		In order to switch between default view of the user and student view, the following code was added. When in default view, the instructor is presented with a link, ''Open Student View'', to switch to student view and when in student view, the ''Close Student View'' link can be used to switch back to the default view.
	<pre>		<pre>
	<% if session[:user] and !session[:user].role.student~~? and !session[:user].role.ta~~? %>		<% if session[:user] and !session[:user].role.student? %>
	<% if session.key?(:student_view) %>		<% if session.key?(:student_view) %>
	<%= link_to "Close Student View", {controller: "role_switch", action: "close_student_view"}, method: :post, :style => "color: white" %>		<%= link_to "Close Student View", {controller: "role_switch", action: "close_student_view"}, method: :post, :style => "color: white" %>
	<% else %>		<% else %>
	<%= link_to "Open Student View", {controller: "role_switch", action: "open_student_view"}, method: :post, :style => "color: white" %>		<%= link_to "Open Student View", {controller: "role_switch", action: "open_student_view"}, method: :post, :style => "color: white" %>
			<% end %>
	<% end %>		<% end %>
	~~<% end %>~~
	</pre>		</pre>

	=== expertiza/app/controllers/role_switch_controller.rb ===		=== expertiza/app/controllers/role_switch_controller.rb ===

Zmathew at 22:31, 28 October 2018

2018-10-28T22:31:29Z

← Older revision		Revision as of 22:31, 28 October 2018
Line 122:		Line 122:

	== Automated Test Plan ==		== Automated Test Plan ==

			The following lines are added to '''spec/features/student_view_spec.rb''' file.

	1. '''Check whether ''Assignments'' is absent in the menu in default view and there is an option to ''Open Student View'''''		1. '''Check whether ''Assignments'' is absent in the menu in default view and there is an option to ''Open Student View'''''
	This test case is to check if the menu item ''Assignments'' is absent when an instructor is in default view. ~~The following lines can~~ be ~~added to a spec/features file:~~		This test case is to check if the menu item ''Assignments'' is absent and 'Open Student View' link is present when an instructor is in default view. Also on clicking the 'Manage...' button the 'Student View' sub-menu item should be listed.

	<pre>		<pre>
	it " can display relevant menu items after login as an admin/instructor/TA", js: true do		it "can display relevant menu items after login as an admin/instructor/TA", js: true do
	create(:instructor)		create(:instructor)
	login_as 'instructor6'		login_as 'instructor6'
	visit '/tree_display/list'		visit '/tree_display/list'
	expect(page).to have_current_path('/tree_display/list')		expect(page).to have_current_path('/tree_display/list')
	expect(page).to have_content('~~Manage content')~~		expect(page).to have_content('Open Student View')
	~~expect(page).to have_content('Survey Deployments~~')
	expect(page).not_to have_content('Assignments')		expect(page).not_to have_content('Assignments')
	expect(page).~~not_to~~ have_content('~~Course Evaluation~~')		click_button "Manage..."
			expect(page).to have_content('Student View')
	end		end
	</pre>		</pre>

	2. '''Check whether ''~~Manage content~~'' and ''~~Survey Deployments~~'' ~~are hidden in student view.~~'''		2. '''Check whether ''Assignments'' is present in the menu in default view and there is an option to ''Close Student View'''''
	This test case is to check if the menu ~~items~~ ''~~Manage content~~'' and ''~~Survey Deployments~~'' are ~~hidden~~ when the instructor switches to student view. The following lines are to be added:		This test case is to check if the menu item ''Assignments'' and link ''Close Student View'' are present when the instructor switches to student view. The following lines are to be added:

	<pre>		<pre>
Line 146:		Line 149:
	login_as 'instructor6'		login_as 'instructor6'
	visit '/tree_display/list'		visit '/tree_display/list'
	click_link '~~Swtich to~~ Student View'		click_link 'Open Student View'
	expect(page).to have_current_path('/student_task/list')		expect(page).to have_current_path('/student_task/list')
	expect(page).to have_content('Assignments')		expect(page).to have_content('Assignments')
	expect(page).to have_content('~~Course Evaluation')~~		expect(page).to have_content('Close Student View')
	~~expect(page).not_to have_content('Manage content')~~
	~~expect(page).not_to have_content('Survey Deployments~~')
	end		end
	</pre>		</pre>

Zmathew at 21:57, 28 October 2018

2018-10-28T21:57:13Z

@@ Line 88: / Line 88: @@
      end
    end
 </pre>

Zmathew at 21:50, 28 October 2018

2018-10-28T21:50:45Z

← Older revision		Revision as of 21:50, 28 October 2018
Line 31:		Line 31:
	== Implementation ==		== Implementation ==
	=== expertiza/app/views/shared/_navigation.html.erb ===		=== expertiza/app/views/shared/_navigation.html.erb ===
	This file is shared between all views and is responsible for rendering all the elements in the ~~top-most part of the web page. (i.e Displaying~~ the menu items~~, the logout button etc~~.)		This file is shared between all views and is responsible for rendering all the elements on the navigation bar including the menu items.

	In order to switch between ~~'''instructor~~ view~~'''~~ and ~~'''~~student view~~'''~~, the following code was added. When ~~the user is~~ in ~~'''instructor~~ view~~'''~~, ~~there~~ is a link ~~named "Switch to~~ Student View" to switch to ~~'''~~student view~~'''~~ and when ~~the user is~~ in ~~'''~~student view''', '~~here is a~~ link ~~named "Revert to Instructor View"~~ to switch back to the ~~'''instructor~~ view~~'''~~.		In order to switch between default view and student view, the following code was added. When in default view, the instructor is presented with a link, ''Open Student View'', to switch to student view and when in student view, the ''Close Student View'' link can be used to switch back to the default view.
	<% if session[:user].role.~~instructor~~? %>		<pre>
	<% if session.key?(:student_view) %>		<% if session[:user] and !session[:user].role.student? and !session[:user].role.ta? %>
	<%= link_to "~~Revert to Instructor~~ View", {controller: "~~instructor~~", action: "~~revert_to_instructor_view~~"},		<% if session.key?(:student_view) %>
	method: :post, :style => "color: white" %>		<%= link_to "Close Student View", {controller: "role_switch", action: "close_student_view"}, method: :post, :style => "color: white" %>
	<% else %>		<% else %>
	<%= link_to "~~Switch to~~ Student View", {controller: "~~instructor~~", action: "~~set_student_view~~"},		<%= link_to "Open Student View", {controller: "role_switch", action: "open_student_view"}, method: :post, :style => "color: white" %>
	method: :post, :style => "color: white" %>		<% end %>
	<% end %>		<% end %>
	<% end %>		</pre>
			=== expertiza/app/controllers/role_switch_controller.rb ===
	=== expertiza/app/controllers/~~instructor_controller~~.rb ===

	A new role_switch_controller.rb file has been added. This controller contains the actions to open/close student view.		A new ''role_switch_controller.rb'' file has been added. This controller contains the actions to open/close student view.
	<pre>		<pre>
	class RoleSwitchController < ApplicationController		class RoleSwitchController < ApplicationController
Line 92:		Line 91:

	== Manual UI Testing ==		== Manual UI Testing ==

	~~The user needs to log-in as an instructor to view this functionality.~~

	1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.		1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.
Line 109:		Line 106:

	== Automated Test Plan ==		== Automated Test Plan ==
	1. '''Check whether ''Assignments'' and ''~~Course Evaluation~~'' ~~are hidden when in instructor view.~~'''		1. '''Check whether ''Assignments'' is absent in the menu in default view and there is an option to ''Open Student View'''''
	This test case is to check if the menu ~~items~~ ''Assignments'' ~~and ''Course Evaluation'' are hidden~~ when an instructor is in ~~instructor~~ view. The following lines can be added to a spec/features file:		This test case is to check if the menu item ''Assignments'' is absent when an instructor is in default view. The following lines can be added to a spec/features file:

	<pre>		<pre>

Zmathew at 21:14, 28 October 2018

2018-10-28T21:14:37Z

← Older revision		Revision as of 21:14, 28 October 2018
Line 46:		Line 46:
	=== expertiza/app/controllers/instructor_controller.rb ===		=== expertiza/app/controllers/instructor_controller.rb ===

	A new ~~instructor_controller~~.rb file has been added. This controller ~~currently~~ contains the actions to ~~switch to~~ student ~~view and revert back to instructor~~ view.		A new role_switch_controller.rb file has been added. This controller contains the actions to open/close student view.
	<pre>		<pre>
	class ~~InstructorController~~ < ApplicationController		class RoleSwitchController < ApplicationController
	# check to see if the current action is allowed		# check to see if the current action is allowed
	def action_allowed?		def action_allowed?
	# ~~only an~~ instructor is allowed to perform all the actions in		# instructor,admin,superadmin is allowed to perform all the actions in
	# this controller		# this controller
	~~return true if session~~[~~:user~~].~~role.instructor~~?		['Super-Administrator',
			'Administrator',
			'Instructor'].include? current_role_name
	end		end

	# sets student_view in session object and redirects to		# sets student_view in session object and redirects to
	# student_task/list after updating ~~hidden_menu_items~~		# student_task/list after updating menu list
	def ~~set_student_view~~		def open_student_view
	session[:student_view] = true		session[:student_view] = true
	~~MenuItemsHelper~~.~~update_hidden_menu_items_for_student_view(~~session)		role = Role.student
			session[:menu] = role.cache[:menu]
	redirect_to controller: 'student_task', action: 'list'		redirect_to controller: 'student_task', action: 'list'
	end		end

	# ~~destroys~~ student_view in session object and redirects to		# closes student_view in session object and redirects to
	# tree_display/list after ~~updating hidden_menu_items~~		# tree_display/list after reverting the menu list as per the role
	def ~~revert_to_instructor_view~~		def close_student_view
	session.delete(:student_view)		session.delete(:student_view)
	~~MenuItemsHelper~~.~~update_hidden_menu_items_for_instructor_view(~~session)		role = session[:user].role
			session[:menu] = role.cache[:menu]
	redirect_to controller: 'tree_display', action: 'list'		redirect_to controller: 'tree_display', action: 'list'
	end		end
Line 76:		Line 80:
	=== expertiza/config/routes.rb ===		=== expertiza/config/routes.rb ===

	New post methods are added in ''config/routes.rb''. The routes are directed to the ~~instructor~~ controller's ''~~set_student_view~~'' and ''~~revert_to_instructor_view~~'' actions.		New post methods are added in ''config/routes.rb''. The routes are directed to the role switch controller's ''open_student_view'' and ''close_student_view'' actions.

	<pre>		<pre>
	resources :~~instructor~~, only: [] do		resources :role_switch, only: [] do
	collection do		collection do
	post :~~set_student_view~~		post :open_student_view
	post :~~revert_to_instructor_view~~		post :close_student_view
	end		end
	end		end

	</pre>		</pre>

Line 140:		Line 143:

	== External Links ==		== External Links ==
	# Link to forked repository [[https://github.com/~~akshayravichandran~~/expertiza]]		# Link to forked repository [[https://github.com/hrshagrwl/expertiza]]
	~~# Link to screen cast [[https://youtu.be/lRZT4q7YDLA~~]]

	==References==		==References==

Zmathew at 21:01, 28 October 2018

2018-10-28T21:01:16Z

← Older revision		Revision as of 21:01, 28 October 2018
Line 92:		Line 92:
	The user needs to log-in as an instructor to view this functionality.		The user needs to log-in as an instructor to view this functionality.

	1. ~~Log into Expertiza~~ as an instructor. Enter 'instructor6' as username and 'password' as password.		1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.

	2. Click on '''~~Switch to~~ Student View''' below username to switch to student view.		2. Click on '''Open Student View''' below username to switch to student view.


Line 100:		Line 100:


	3. Click on '''~~Revert to Instructor~~ View'''' below username to come back to ~~instructor~~ view.		3. Click on '''Close Student View''' below username to come back to default view.


	[[File:~~new_student_view~~.png]]		[[File:student_view.png]]

	== Automated Test Plan ==		== Automated Test Plan ==