Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2015 E1579 Instructor account creation over the web

2015-12-07T20:19:01Z

Abonam:

== '''Introduction to Expertiza''' ==

Expertiza[https://expertiza.ncsu.edu/wiki/] is a project developed using Ruby on Rails[https://en.wikipedia.org/wiki/Ruby_on_Rails]. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an open source application and the code can be cloned from GitHub[https://en.wikipedia.org/wiki/GitHub]. This application provides an efficient way to manage assignments, grades and reviews. This makes the process easier and faster when the class strength is large.

== '''Purpose''' ==

The purpose of this project is to allow new users to access the system and experiment with all the features of Expertiza and make a “Demo like” feel for the new user where the user can experiment with it. This project adds a new feature of Instructor Creation over the web which is completely different from the previous way the user and instructor accounts were created by existing super administrators. Code will be restructured to convey readability, handle exceptions.

== '''Scope''' ==

The scope of this project will involve adding a new View/Page that would input all the new user(Instructor) Details which would be a signup page.The signup page will be designed in a way which would have security feature as Captchas embedded into it. There would be another new View/Page created that would act as the landing page for the newly created Demo_instructor which would contain specific instructions/ Video on how to add assignments, add students to the assignments. Also an email is sent soon after a successful creation of such user. The project also deals with providing no access to the public features, which could be extended manually by a super admin.The code will also be tested well to ensure the robustness of newly added functionality without compromising the existing working functionalities.

=='''Implementation'''==

==== Project outcomes ====
*Create a new role by SuperAdmin
**Fixed the drop-down menu for Based on roles option while creating a new.
**Fixed add new permissions for a role functionality.

*Allow people to request instructor accounts over the web.
**Added a Link in Main Screen “Demo Instructor signup”.
**Created a New Page where the User Fills the details wrt to a new Instructor Privileged access.
**Included Captcha Functionality and other necessary features for a secure Sign Up.
**Fixed role permission deletion functionality.

*Upon Successful Creation of Instructor Account.
**Redirect the New Instructor back to the Login Page.
**Send an email to the super Admin notifying him of a new Instructor that has been created over the web
**Send an email to new user with username and new password details.

*Upon Successful Login of the New Instructor
**Redirect the User to a Instruction Page which gives information on how to create an assignments and register students for it and other basic information needed. Basically a instructions page that can be used for providing information.
**Provided a Button (Proceed) that would redirect him to the main Expertiza page.
**Made sure that he does not see any Public entities( assignments, Courses) created by any other TA's, Admins or Super Admins.
**Demo user has a general access to Expertiza and should be able to perform basic actions like adding a course, adding an assignment & assigning students for the created assignments.

==== Files to be changed ====
*role.rb
*tree_display_controller.rb
*auth_controller.rb
*auth/_login.html.erb

==== Files Added ====
*demo_controller.rb
*tree_display_demo.jsx
*tree_display/list_for_demo.html.erb
*tree_display_demo.scss
*demo_controller_spec.rb
*demo_controller/instructions_page.html.erb

====Future scope for improvements====
*The save functionality after editing an assignment throws an error which needs to be checked upon.

'''The demo_controller is created to support the main functionalities'''

def action_allowed?
true
end

def new
@demo_role = Role.find_by_name("demo_instructor")
if @demo_role
@user = User.new
@demo_role_id = @demo_role.id
else
flash[:error] = "Demo Instructor Role not yet created"
redirect_to '/'
end
end

def instruction_page
end

def proceed
redirect_to :controller => 'tree_display', :action => 'list'
end

def create
if simple_captcha_valid?
check = User.find_by_name(params[:user][:name])
if check != nil
params[:user][:name] = params[:user][:email]
end
@user = User.new(user_params)
if @user.save
password = @user.reset_password # the password is reset
MailerHelper::send_mail_to_user(@user, "Your Expertiza account and password have been created", "user_welcome", password).deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
redirect_to '/'
else
flash[:error] = "Please check on the credentials again and re enter."
render :action => 'new'
end
else
flash[:error] = "Please ENTER the correct CAPTCHA code"
render :action => 'new'
end
end

def show
end

def user_params
params.require(:user).permit(:name, :crypted_password, :role_id, :password_salt, :fullname, :email, :parent_id, :private_by_default,
:mru_directory_path, :email_on_review, :email_on_submission, :email_on_review_of_review, :is_new_user, :master_permission_granted, :handle, :leaderboard_privacy, :digital_certificate, :persistence_token, :timezonepref, :public_key, :copy_of_emails,:institutions_id)
end
'''Refactored code in tree_display_controller'''

if ['Super-Administrator', 'Administrator','Instructor','Teaching Assistant'].include? current_role_name
res[nodeType] << tmpObject
elsif node.get_instructor_id===session[:user].id
res[nodeType] << tmpObject
end

 

'''For the creation of Demo Instructor experimenting with the features of expertiza
'''
 

In the controller admin_controller.rb, the new actions to be added and their purpose is explained below.

Action added: create_demo_instructor role 
Purpose: create role for the demo_instructor by super administrator

Action added: new_demo_instructor signup 
Purpose: Linked to the Signup form for creating an instructor to allow the experimenting with expertiza features

Action added: Display instructions page for demo user 
Purpose: Show case all the instructions for a new instructor.

Action added : remove_demo_instructor 
Purpose: For the super administrator to remove the instructor

The corresponding views for the new_demo_instructor, list_demo_instructors, remove_demo_instructor are added manually.
 

'''Upon Demo Instructor Login into the account created
'''
 
In the tree_display_controller.rb, goto_instructions action is added and instructions.html.erb view is created for this action. instructions.html.erb contains the instructions required for the creation of courses, assignments, adding participants to assignments, etc.

== '''Requirements''' ==

The main objective for the project is to add the new signup functionality for the new User and also to clarify and improve code quality. Although specific implementation details will change through this process, the functionality of the system will remain intact. The overall requirements to the system will therefore not change. We need to make sure that the new demo instructor will not be able to see all the public entities of other instructors, TA's. need to implement and change all the necessary files to make sure unnecessary items are not showcased to the demo instructor.

== ''' Flow ''' ==
The following diagram represents the high level flow of control in the project.

[[File:Capture.PNG]]

== '''Mock Ups ''' ==

The role creation page by super administrator.

[[File: Course.png‎]]

The instructions page will have few instructions and a Simple Video Tutorial.

[[File: Instructions page.png]]

The Expertiza Home page with the Demo_Instructor.

[[File: Role creation.png]]

== '''Use Cases''' ==

'''1.Sign-up as new Instructor''': New users can signup to view all features(except the public entities).

'''2.View instructions page''': New instructor can view an instructions page for a walk through of the features.

'''3.Super-admin gives access:''' Super-admin gives access to all public entities for the newly created instructor.

'''4.New instructor-private items''' The demo instructor can access all the private items.

== '''Use case Diagram'''==

[[File:Uml_oodd.png‎ ]]

We would be writing the below test cases so as to make sure all the necessary functionalities are properly implemented and tested.

== '''Test Cases'''==
'''1.Sign-up Test Case''': We will be checking if the demo user provides all the inputs needed for proper signup along with passing the Captcha .

'''2.Landing Page Test Case''': Will be checking on if all the demo users land on the same Instruction page and if other Users like TA/SuperUser/Instructors do not land on the Instruction page.

'''3. Accessibility Test''': The Demo User should be only be able to access his only entities and not the Public entities of other users(TA/SuperUser/Instructors).

'''4. Adding Entities Test Case''': Will check if the Demo user is able to 1) create Assignments, 2) Add students to Assignments, 3) Make Questionnaires and have access to these entities.

== ''' References ''' ==
[https://expertiza.ncsu.edu/ Expertiza home page] 
[https://en.wikipedia.org/wiki/GitHub Github Wikipedia Page] 
[https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails Wikipedia Page] 
[http://research.csc.ncsu.edu/efg/expertiza/papers Papers on Expertiza]

CSC/ECE 517 Fall 2015 E1579 Instructor account creation over the web

2015-12-05T05:07:26Z

Abonam:

== '''Introduction to Expertiza''' ==

Expertiza[https://expertiza.ncsu.edu/wiki/] is a project developed using Ruby on Rails[https://en.wikipedia.org/wiki/Ruby_on_Rails]. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an open source application and the code can be cloned from GitHub[https://en.wikipedia.org/wiki/GitHub]. This application provides an efficient way to manage assignments, grades and reviews. This makes the process easier and faster when the class strength is large.

== '''Purpose''' ==

The purpose of this project is to allow new users to access the system and experiment with all the features of Expertiza and make a “Demo like” feel for the new user where the user can experiment with it. This project adds a new feature of Instructor Creation over the web which is completely different from the previous way the user and instructor accounts were created by existing super administrators. Code will be restructured to convey readability, handle exceptions.

== '''Scope''' ==

The scope of this project will involve adding a new View/Page that would input all the new user(Instructor) Details which would be a signup page.The signup page will be designed in a way which would have security feature as Captchas embedded into it. There would be another new View/Page created that would act as the landing page for the newly created Demo_instructor which would contain specific instructions/ Video on how to add assignments, add students to the assignments. Also an email is sent soon after a successful creation of such user. The project also deals with providing no access to the public features, which could be extended manually by a super admin.The code will also be tested well to ensure the robustness of newly added functionality without compromising the existing working functionalities.

=='''Implementation'''==

==== Project outcomes ====
*Create a new role by SuperAdmin
**Fixed the drop-down menu for Based on roles option while creating a new.
**Fixed add new permissions for a role functionality.

*Allow people to request instructor accounts over the web.
**Added a Link in Main Screen “Demo Instructor signup”.
**Created a New Page where the User Fills the details wrt to a new Instructor Privileged access.
**Included Captcha Functionality and other necessary features for a secure Sign Up.
**Fixed role permission deletion functionality.

*Upon Successful Creation of Instructor Account.
**Redirect the New Instructor back to the Login Page.
**Send an email to the super Admin notifying him of a new Instructor that has been created over the web
**Send an email to new user with username and new password details.

*Upon Successful Login of the New Instructor
**Redirect the User to a Instruction Page which gives information on how to create an assignments and register students for it and other basic information needed. Basically a instructions page that can be used for providing information.
**Provided a Button (Proceed) that would redirect him to the main Expertiza page.
**Made sure that he does not see any Public entities( assignments, Courses) created by any other TA's, Admins or Super Admins.
**Demo user has a general access to Expertiza and should be able to perform basic actions like adding a course, adding an assignment & assigning students for the created assignments.

==== Files to be changed ====
*role.rb
*tree_display_controller.rb
*auth_controller.rb
*auth/_login.html.erb

==== Files Added ====
*demo_controller.rb
*tree_display_demo.jsx
*tree_display/list_for_demo.html.erb
*tree_display_demo.scss
*demo_controller_spec.rb
*demo_controller/instructions_page.html.erb

'''The demo_controller is created to support the main functionalities'''

def action_allowed?
true
end

def new
@demo_role = Role.find_by_name("demo_instructor")
if @demo_role
@user = User.new
@demo_role_id = @demo_role.id
else
flash[:error] = "Demo Instructor Role not yet created"
redirect_to '/'
end
end

def instruction_page
end

def proceed
redirect_to :controller => 'tree_display', :action => 'list'
end

def create
if simple_captcha_valid?
check = User.find_by_name(params[:user][:name])
if check != nil
params[:user][:name] = params[:user][:email]
end
@user = User.new(user_params)
if @user.save
password = @user.reset_password # the password is reset
MailerHelper::send_mail_to_user(@user, "Your Expertiza account and password have been created", "user_welcome", password).deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
redirect_to '/'
else
flash[:error] = "Please check on the credentials again and re enter."
render :action => 'new'
end
else
flash[:error] = "Please ENTER the correct CAPTCHA code"
render :action => 'new'
end
end

def show
end

def user_params
params.require(:user).permit(:name, :crypted_password, :role_id, :password_salt, :fullname, :email, :parent_id, :private_by_default,
:mru_directory_path, :email_on_review, :email_on_submission, :email_on_review_of_review, :is_new_user, :master_permission_granted, :handle, :leaderboard_privacy, :digital_certificate, :persistence_token, :timezonepref, :public_key, :copy_of_emails,:institutions_id)
end
'''Refactored code in tree_display_controller'''

if ['Super-Administrator', 'Administrator','Instructor','Teaching Assistant'].include? current_role_name
res[nodeType] << tmpObject
elsif node.get_instructor_id===session[:user].id
res[nodeType] << tmpObject
end

 

'''For the creation of Demo Instructor experimenting with the features of expertiza
'''
 

In the controller admin_controller.rb, the new actions to be added and their purpose is explained below.

Action added: create_demo_instructor role 
Purpose: create role for the demo_instructor by super administrator

Action added: new_demo_instructor signup 
Purpose: Linked to the Signup form for creating an instructor to allow the experimenting with expertiza features

Action added: Display instructions page for demo user 
Purpose: Show case all the instructions for a new instructor.

Action added : remove_demo_instructor 
Purpose: For the super administrator to remove the instructor

The corresponding views for the new_demo_instructor, list_demo_instructors, remove_demo_instructor are added manually.
 

'''Upon Demo Instructor Login into the account created
'''
 
In the tree_display_controller.rb, goto_instructions action is added and instructions.html.erb view is created for this action. instructions.html.erb contains the instructions required for the creation of courses, assignments, adding participants to assignments, etc.

== '''Requirements''' ==

The main objective for the project is to add the new signup functionality for the new User and also to clarify and improve code quality. Although specific implementation details will change through this process, the functionality of the system will remain intact. The overall requirements to the system will therefore not change. We need to make sure that the new demo instructor will not be able to see all the public entities of other instructors, TA's. need to implement and change all the necessary files to make sure unnecessary items are not showcased to the demo instructor.

== ''' Flow ''' ==
The following diagram represents the high level flow of control in the project.

[[File:Capture.PNG]]

== '''Mock Ups ''' ==

The role creation page by super administrator.

[[File: Course.png‎]]

The instructions page will have few instructions and a Simple Video Tutorial.

[[File: Instructions page.png]]

The Expertiza Home page with the Demo_Instructor.

[[File: Role creation.png]]

== '''Use Cases''' ==

'''1.Sign-up as new Instructor''': New users can signup to view all features(except the public entities).

'''2.View instructions page''': New instructor can view an instructions page for a walk through of the features.

'''3.Super-admin gives access:''' Super-admin gives access to all public entities for the newly created instructor.

'''4.New instructor-private items''' The demo instructor can access all the private items.

== '''Use case Diagram'''==

[[File:Uml_oodd.png‎ ]]

We would be writing the below test cases so as to make sure all the necessary functionalities are properly implemented and tested.

== '''Test Cases'''==
'''1.Sign-up Test Case''': We will be checking if the demo user provides all the inputs needed for proper signup along with passing the Captcha .

'''2.Landing Page Test Case''': Will be checking on if all the demo users land on the same Instruction page and if other Users like TA/SuperUser/Instructors do not land on the Instruction page.

'''3. Accessibility Test''': The Demo User should be only be able to access his only entities and not the Public entities of other users(TA/SuperUser/Instructors).

'''4. Adding Entities Test Case''': Will check if the Demo user is able to 1) create Assignments, 2) Add students to Assignments, 3) Make Questionnaires and have access to these entities.

== ''' References ''' ==
[https://expertiza.ncsu.edu/ Expertiza home page] 
[https://en.wikipedia.org/wiki/GitHub Github Wikipedia Page] 
[https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails Wikipedia Page] 
[http://research.csc.ncsu.edu/efg/expertiza/papers Papers on Expertiza]

CSC/ECE 517 Fall 2015 E1579 Instructor account creation over the web

2015-11-14T05:31:49Z

Abonam: /* UML Diagram */

== '''Introduction to Expertiza''' ==

Expertiza is a project developed using Ruby on Rails. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an open source application and the code can be cloned from GitHub. This application provides an efficient way to manage assignments, grades and reviews. This makes the process easier and faster when the class strength is large.

== '''Purpose''' ==

The purpose of this project is to allow new users to access the system and experiment with all the features of Expertiza and make a “Demo like” feel for the new user where the user can experiment with it. This project adds a new feature of Instructor Creation over the web which is completely different from the previous way the user and instructor accounts were created by existing super administrators, instructors or TAs. Code will be restructured to convey readability, handle exceptions.

== '''Scope''' ==

The scope of this project will involve adding a new View/Page that would input all the new user(Instructor) Details which would be a signup page.The signup page will be designed in a way which would have security feature as Captchas embedded into it. There would be another new View/Page created that would act as the landing page for the newly created Demo_instructor which would contain specific instructions/ Video on how to add assignments, add students to the assignments. Also an email is sent soon after a successful creation of such user. The project also deals with providing limited access to all the features, which could be extended manually by a super admin.The code will also be tested well to ensure the robustness of newly added functionality without compromising the existing working functionalities.

=='''Implementation'''==

==== What needs to be done ====

*Allow people to request instructor accounts over the web.
**Add a Link in Main Screen “Instructor Account request”.
**Create a New Page where the User Fills the details wrt to a new Instructor Privileged access.
**Include Captcha Functionality and other necessary features for a secure Sign Up.

*Upon Successful Creation of Instructor Account.
**Redirect the New Instructor back to the Login Page.
**Send an email to the super Admin notifying him of a new Instructor that has been created over the web

*Upon Successful Login of the New Instructor
**Redirect the User to a New Landing Page/Instruction Page which gives information on how to create an assignments and register students for it and other basic information needed. Basically a Placeholder page that can be used for providing information.
**Provide a Button that would redirect him to the main Expertiza page.
**Make sure that he does not see any Public entities( assignments, Courses) created by any other TA's, Admins or Super Admins.
**Should have a general access to Expertiza and should be able to perform basic actions like adding a course, adding an assignment and assigning students for the created assignments.

==== Files to be changed ====
*role.rb
*instructor.rb
*roles_permission.rb
*roles_permission_controller.rb
*sign_up_sheet_controller.rb

'''A role named Demo-Instructor is added to the added to the role.rb model with the following code:'''

def self.demo_instructor
@@instructor_role ||= find_by_name 'Demo-Instructor'
end

def demo_instructor?
name['Demo-Instructor']
end

Various controller and model files containing action_allowed? should be updated as

def action_allowed?
['Instructor', 'Teaching Assistant', 'Administrator', 'Super-Administrator', 'Student', 'Demo-Instructor'].include? current_role_name
end

roles table will be updated will be updated by the super-administrator from the new.html.erb form associated with the new action of roles_controller
 

'''For the creation of Demo Instructor experimenting with the features of expertiza
'''
 

In the controller admin_controller.rb, the new actions to be added and their purpose is explained below.

Action added: new_demo_instructor 
Purpose: Linked to the Signup form for creating an instructor to allow the experimenting with expertiza features

Action added: create_demo_instructor 
Purpose: the save operation for the instructor created into the database

Action added: list_demo_instructors 
Purpose: To list them

Action added : remove_demo_instructor 
Purpose: For the super administrator to remove the instructor

The corresponding views for the new_demo_instructor, list_demo_instructors, remove_demo_instructor are added manually.
 

'''Upon Demo Instructor Login into the account created
'''
 
In the tree_display_controller.rb, goto_instructions action is added and instructions.html.erb view is created for this action. instructions.html.erb contains the instructions required for the creation of courses, assignments, adding participants to assignments, etc.

== '''Requirements''' ==

The main objective for the project is to add the new signup functionality for the new User and also to clarify and improve code quality. Although specific implementation details will change through this process, the functionality of the system will remain intact. The overall requirements to the system will therefore not change. We need to make sure that the new demo instructor will not be able to see all the public entities of other instructors, TA's. need to implement and change all the necessary files to make sure unnecessary items are not showcased to the demo instructor.

== '''Mock Ups ''' ==

The Expertiza Login page with the Instructor Account Request Link.

[[File: Homepage.PNG]]

The PlaceHolder page will have few instructions and a Simple Video Tutorial.

[[File: Placehlder.PNG]]

The home page for demo instructor excluding public entities.

[[File: Instructor_default_page_(1).PNG]]

== '''Use Cases''' ==

'''1.Sign-up as new Instructor''': New users can signup to view all features(except the public entities).

'''2.View instructions page''': New instructor can view an instructions page for a walk through of the features.

'''3.Super-admin gives access:''' Super-admin gives access to all public entities for the newly created instructor.

'''4.New instructor-private items''' The demo instructor can access all the private items.

== '''Use case Diagram'''==

[[File:Uml_oodd.png‎ ]]

== ''' References ''' ==
[https://expertiza.ncsu.edu/ Expertiza home page] 
[http://research.csc.ncsu.edu/efg/expertiza/papers Papers on Expertiza]

CSC/ECE 517 Fall 2015 E1579 Instructor account creation over the web

2015-11-14T05:29:31Z

Abonam: /* Use Cases */

== '''Introduction to Expertiza''' ==

Expertiza is a project developed using Ruby on Rails. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an open source application and the code can be cloned from GitHub. This application provides an efficient way to manage assignments, grades and reviews. This makes the process easier and faster when the class strength is large.

== '''Purpose''' ==

The purpose of this project is to allow new users to access the system and experiment with all the features of Expertiza and make a “Demo like” feel for the new user where the user can experiment with it. This project adds a new feature of Instructor Creation over the web which is completely different from the previous way the user and instructor accounts were created by existing super administrators, instructors or TAs. Code will be restructured to convey readability, handle exceptions.

== '''Scope''' ==

The scope of this project will involve adding a new View/Page that would input all the new user(Instructor) Details which would be a signup page.The signup page will be designed in a way which would have security feature as Captchas embedded into it. There would be another new View/Page created that would act as the landing page for the newly created Demo_instructor which would contain specific instructions/ Video on how to add assignments, add students to the assignments. Also an email is sent soon after a successful creation of such user. The project also deals with providing limited access to all the features, which could be extended manually by a super admin.The code will also be tested well to ensure the robustness of newly added functionality without compromising the existing working functionalities.

=='''Implementation'''==

==== What needs to be done ====

*Allow people to request instructor accounts over the web.
**Add a Link in Main Screen “Instructor Account request”.
**Create a New Page where the User Fills the details wrt to a new Instructor Privileged access.
**Include Captcha Functionality and other necessary features for a secure Sign Up.

*Upon Successful Creation of Instructor Account.
**Redirect the New Instructor back to the Login Page.
**Send an email to the super Admin notifying him of a new Instructor that has been created over the web

*Upon Successful Login of the New Instructor
**Redirect the User to a New Landing Page/Instruction Page which gives information on how to create an assignments and register students for it and other basic information needed. Basically a Placeholder page that can be used for providing information.
**Provide a Button that would redirect him to the main Expertiza page.
**Make sure that he does not see any Public entities( assignments, Courses) created by any other TA's, Admins or Super Admins.
**Should have a general access to Expertiza and should be able to perform basic actions like adding a course, adding an assignment and assigning students for the created assignments.

==== Files to be changed ====
*role.rb
*instructor.rb
*roles_permission.rb
*roles_permission_controller.rb
*sign_up_sheet_controller.rb

'''A role named Demo-Instructor is added to the added to the role.rb model with the following code:'''

def self.demo_instructor
@@instructor_role ||= find_by_name 'Demo-Instructor'
end

def demo_instructor?
name['Demo-Instructor']
end

Various controller and model files containing action_allowed? should be updated as

def action_allowed?
['Instructor', 'Teaching Assistant', 'Administrator', 'Super-Administrator', 'Student', 'Demo-Instructor'].include? current_role_name
end

roles table will be updated will be updated by the super-administrator from the new.html.erb form associated with the new action of roles_controller
 

'''For the creation of Demo Instructor experimenting with the features of expertiza
'''
 

In the controller admin_controller.rb, the new actions to be added and their purpose is explained below.

Action added: new_demo_instructor 
Purpose: Linked to the Signup form for creating an instructor to allow the experimenting with expertiza features

Action added: create_demo_instructor 
Purpose: the save operation for the instructor created into the database

Action added: list_demo_instructors 
Purpose: To list them

Action added : remove_demo_instructor 
Purpose: For the super administrator to remove the instructor

The corresponding views for the new_demo_instructor, list_demo_instructors, remove_demo_instructor are added manually.
 

'''Upon Demo Instructor Login into the account created
'''
 
In the tree_display_controller.rb, goto_instructions action is added and instructions.html.erb view is created for this action. instructions.html.erb contains the instructions required for the creation of courses, assignments, adding participants to assignments, etc.

== '''Requirements''' ==

The main objective for the project is to add the new signup functionality for the new User and also to clarify and improve code quality. Although specific implementation details will change through this process, the functionality of the system will remain intact. The overall requirements to the system will therefore not change. We need to make sure that the new demo instructor will not be able to see all the public entities of other instructors, TA's. need to implement and change all the necessary files to make sure unnecessary items are not showcased to the demo instructor.

== '''Mock Ups ''' ==

The Expertiza Login page with the Instructor Account Request Link.

[[File: Homepage.PNG]]

The PlaceHolder page will have few instructions and a Simple Video Tutorial.

[[File: Placehlder.PNG]]

The home page for demo instructor excluding public entities.

[[File: Instructor_default_page_(1).PNG]]

== '''Use Cases''' ==

'''1.Sign-up as new Instructor''': New users can signup to view all features(except the public entities).

'''2.View instructions page''': New instructor can view an instructions page for a walk through of the features.

'''3.Super-admin gives access:''' Super-admin gives access to all public entities for the newly created instructor.

'''4.New instructor-private items''' The demo instructor can access all the private items.

== '''UML Diagram'''==

''UML diagram for use cases''
[[File:Uml_oodd.png‎ ]]

== ''' References ''' ==
[https://expertiza.ncsu.edu/ Expertiza home page] 
[http://research.csc.ncsu.edu/efg/expertiza/papers Papers on Expertiza]

File:Uml oodd.png

2015-11-14T05:27:05Z

Abonam:

CSC/ECE 517 Fall 2015 E1579 Instructor account creation over the web

2015-11-14T04:50:52Z

Abonam: /* Files to be changed */

== '''Introduction to Expertiza''' ==

Expertiza is a project developed using Ruby on Rails. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an open source application and the code can be cloned from GitHub. This application provides an efficient way to manage assignments, grades and reviews. This makes the process easier and faster when the class strength is large.

== '''Purpose''' ==

The purpose of this project is to allow new users to access the system and experiment with all the features of Expertiza and make a “Demo like” feel for the new user where the user can experiment with it. This project adds a new feature of Instructor Creation over the web which is completely different from the previous way the user and instructor accounts were created by existing super administrators, instructors or TAs. Code will be restructured to convey readability, handle exceptions.

== '''Scope''' ==

The scope of this project will involve adding a new View/Page that would input all the new user(Instructor) Details which would be a signup page.The signup page will be designed in a way which would have security feature as Captchas embedded into it. There would be another new View/Page created that would act as the landing page for the newly created Demo_instructor which would contain specific instructions/ Video on how to add assignments, add students to the assignments. Also an email is sent soon after a successful creation of such user. The project also deals with providing limited access to all the features, which could be extended manually by a super admin.The code will also be tested well to ensure the robustness of newly added functionality without compromising the existing working functionalities.

=='''Implementation'''==

==== What needs to be done ====

*Allow people to request instructor accounts over the web.
**Add a Link in Main Screen “Instructor Account request”.
**Create a New Page where the User Fills the details wrt to a new Instructor Privileged access.
**Include Captcha Functionality and other necessary features for a secure Sign Up.

*Upon Successful Creation of Instructor Account.
**Redirect the New Instructor back to the Login Page.
**Send an email to the super Admin notifying him of a new Instructor that has been created over the web

*Upon Successful Login of the New Instructor
**Redirect the User to a New Landing Page/Instruction Page which gives information on how to create an assignments and register students for it and other basic information needed. Basically a Placeholder page that can be used for providing information.
**Provide a Button that would redirect him to the main Expertiza page.
**Make sure that he does not see any Public entities( assignments, Courses) created by any other TA's, Admins or Super Admins.
**Should have a general access to Expertiza and should be able to perform basic actions like adding a course, adding an assignment and assigning students for the created assignments.

==== Files to be changed ====
*role.rb
*instructor.rb
*roles_permission.rb
*roles_permission_controller.rb
*sign_up_sheet_controller.rb

'''A role named Demo-Instructor is added to the added to the role.rb model with the following code:'''

def self.demo_instructor
@@instructor_role ||= find_by_name 'Demo-Instructor'
end

def demo_instructor?
name['Demo-Instructor']
end

Various controller and model files containing action_allowed? should be updated as

def action_allowed?
['Instructor', 'Teaching Assistant', 'Administrator', 'Super-Administrator', 'Student', 'Demo-Instructor'].include? current_role_name
end

roles table will be updated will be updated by the super-administrator from the new.html.erb form associated with the new action of roles_controller
 

'''For the creation of Demo Instructor experimenting with the features of expertiza
'''
 

In the controller admin_controller.rb, the new actions to be added and their purpose is explained below.

Action added: new_demo_instructor 
Purpose: Linked to the Signup form for creating an instructor to allow the experimenting with expertiza features

Action added: create_demo_instructor 
Purpose: the save operation for the instructor created into the database

Action added: list_demo_instructors 
Purpose: To list them

Action added : remove_demo_instructor 
Purpose: For the super administrator to remove the instructor

The corresponding views for the new_demo_instructor, list_demo_instructors, remove_demo_instructor are added manually.
 

'''Upon Demo Instructor Login into the account created
'''
 
In the tree_display_controller.rb, goto_instructions action is added and instructions.html.erb view is created for this action. instructions.html.erb contains the instructions required for the creation of courses, assignments, adding participants to assignments, etc.

== '''Requirements''' ==

The main objective for the project is to add the new signup functionality for the new User and also to clarify and improve code quality. Although specific implementation details will change through this process, the functionality of the system will remain intact. The overall requirements to the system will therefore not change. We need to make sure that the new demo instructor will not be able to see all the public entities of other instructors, TA's. need to implement and change all the necessary files to make sure unnecessary items are not showcased to the demo instructor.

== '''Mock Ups ''' ==

The Expertiza Login page with the Instructor Account Request Link.

[[File: Homepage.PNG]]

The PlaceHolder page will have few instructions and a Simple Video Tutorial.

[[File: Placehlder.PNG]]

The home page for demo instructor excluding public entities.

[[File: Instructor_default_page_(1).PNG]]

== '''Use Cases''' ==

'''1.Sign-up as new Instructor''': New users can signup to view all features(except the public entities).

'''2.View instructions page''': New instructor can view an instructions page for a walk through of the features.

'''3.Super-admin gives access:''' Super-admin gives access to all public entities for the newly created instructor.

'''4.New instructor-private items''' The demo instructor can access all the private items.

== ''' References ''' ==
[https://expertiza.ncsu.edu/ Expertiza home page] 
[http://research.csc.ncsu.edu/efg/expertiza/papers Papers on Expertiza]

File:Review rubrics screenshot.png

2015-11-06T22:57:10Z

Abonam: uploaded a new version of "File:Review rubrics screenshot.png": Reverted to version as of 22:32, 6 November 2015

File:Review rubrics screenshot.png

2015-11-06T22:56:45Z

Abonam: uploaded a new version of "File:Review rubrics screenshot.png"

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-11-06T22:54:44Z

Abonam: /* Direct access to sub categories in tree display */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng

|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

==='''How to test the changes from UI'''===

{| class="wikitable"
|-
|
* Login in as an instructor or admin using credentials (admin with password: admin or instructor6 with password: password)
* To check the changes made in go_to_menu_items method, hover over the Manage tab in the navigation bar on the top and click all the links and check whether they are being redirected to correct pages. For example, if Questionnaires is clicked, you should be | redirected directly to the page displaying all the questionnaires with its sub-categories like Reviews, Surveys etc.
* To test the changes made in get_children_node_ng and get_children_node_2_ng methods, click on the sub categories under each of the parent tree displays (Courses, Assignments and Questionnaires) and all of them will further expand to show the details.
|-
|}

=Direct access to sub categories in tree display=
[[File:Review rubrics screenshot.png |center]]

=Checking the direct access tabs from navigation bar=
[[File:Tree screenshot.png]]

=Checking the sub categories in each parent Tree=
[[File:Sub-tree screenshot.png]]

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end

describe "#go_to_menu_items" do
before do
allow(nil).to receive(:find_by_node_object_id).and_return(nil)
allow(nil).to receive(:id).and_return(nil)
allow(nil).to receive(:name).and_return(true)
end
it "should receive Review Rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Review").and_return(nil)
get "go_to_menu_items", params1: "Review Rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Teammate review rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Teammate review").and_return(nil)
get "go_to_menu_items", params1: "Teammate review rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Metareview rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Metareview").and_return(nil)
get "go_to_menu_items", params1: "Metareview rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Author feedbacks and redirect to list" do
allow(nil).to receive(:find_by_name).with("Author Feedback").and_return(nil)
get "go_to_menu_items", params1: "Author feedbacks"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Global surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Global Survey").and_return(nil)
get "go_to_menu_items", params1: "Global surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Course evaluations and redirect to list" do
allow(nil).to receive(:find_by_name).with("Course Evaluation").and_return(nil)
get "go_to_menu_items", params1: "Course evaluations"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Survey").and_return(nil)
get "go_to_menu_items", params1: "Surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should redirect to root_url if request parameter is invalid" do
allow(nil).to receive(:find_by_name).with(nil).and_return(nil)
get "go_to_menu_items"
expect(response).to redirect_to(root_path)
end
end
describe "#drill" do
it "redirect to list action" do
get "drill" , root: 1
session[:root].should == "1"
expect(response).to redirect_to(list_tree_display_index_path)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-11-06T22:39:32Z

Abonam: /* Login using Instructor Credentials */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng

|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

==='''How to test the changes from UI'''===

{| class="wikitable"
|-
|
* Login in as an instructor or admin using credentials (admin with password: admin or instructor6 with password: password)
* To check the changes made in go_to_menu_items method, hover over the Manage tab in the navigation bar on the top and click all the links and check whether they are being redirected to correct pages. For example, if Questionnaires is clicked, you should be | redirected directly to the page displaying all the questionnaires with its sub-categories like Reviews, Surveys etc.
* To test the changes made in get_children_node_ng and get_children_node_2_ng methods, click on the sub categories under each of the parent tree displays (Courses, Assignments and Questionnaires) and all of them will further expand to show the details.
|-
|}

=Direct access to sub categories in tree display=
[[File:Review rubrics screenshot.png]]

=Checking the direct access tabs from navigation bar=
[[File:Tree screenshot.png]]

=Checking the sub categories in each parent Tree=
[[File:Sub-tree screenshot.png]]

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end

describe "#go_to_menu_items" do
before do
allow(nil).to receive(:find_by_node_object_id).and_return(nil)
allow(nil).to receive(:id).and_return(nil)
allow(nil).to receive(:name).and_return(true)
end
it "should receive Review Rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Review").and_return(nil)
get "go_to_menu_items", params1: "Review Rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Teammate review rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Teammate review").and_return(nil)
get "go_to_menu_items", params1: "Teammate review rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Metareview rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Metareview").and_return(nil)
get "go_to_menu_items", params1: "Metareview rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Author feedbacks and redirect to list" do
allow(nil).to receive(:find_by_name).with("Author Feedback").and_return(nil)
get "go_to_menu_items", params1: "Author feedbacks"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Global surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Global Survey").and_return(nil)
get "go_to_menu_items", params1: "Global surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Course evaluations and redirect to list" do
allow(nil).to receive(:find_by_name).with("Course Evaluation").and_return(nil)
get "go_to_menu_items", params1: "Course evaluations"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Survey").and_return(nil)
get "go_to_menu_items", params1: "Surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should redirect to root_url if request parameter is invalid" do
allow(nil).to receive(:find_by_name).with(nil).and_return(nil)
get "go_to_menu_items"
expect(response).to redirect_to(root_path)
end
end
describe "#drill" do
it "redirect to list action" do
get "drill" , root: 1
session[:root].should == "1"
expect(response).to redirect_to(list_tree_display_index_path)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-11-06T22:38:37Z

Abonam: /* Checking the sub categories in each parent Tree */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng

|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

==='''How to test the changes from UI'''===

{| class="wikitable"
|-
|
* Login in as an instructor or admin using credentials (admin with password: admin or instructor6 with password: password)
* To check the changes made in go_to_menu_items method, hover over the Manage tab in the navigation bar on the top and click all the links and check whether they are being redirected to correct pages. For example, if Questionnaires is clicked, you should be | redirected directly to the page displaying all the questionnaires with its sub-categories like Reviews, Surveys etc.
* To test the changes made in get_children_node_ng and get_children_node_2_ng methods, click on the sub categories under each of the parent tree displays (Courses, Assignments and Questionnaires) and all of them will further expand to show the details.
|-
|}

=Login using Instructor Credentials=
[[File:Example.jpg]]

=Checking the direct access tabs from navigation bar=
[[File:Tree screenshot.png]]

=Checking the sub categories in each parent Tree=
[[File:Sub-tree screenshot.png]]

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end

describe "#go_to_menu_items" do
before do
allow(nil).to receive(:find_by_node_object_id).and_return(nil)
allow(nil).to receive(:id).and_return(nil)
allow(nil).to receive(:name).and_return(true)
end
it "should receive Review Rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Review").and_return(nil)
get "go_to_menu_items", params1: "Review Rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Teammate review rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Teammate review").and_return(nil)
get "go_to_menu_items", params1: "Teammate review rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Metareview rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Metareview").and_return(nil)
get "go_to_menu_items", params1: "Metareview rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Author feedbacks and redirect to list" do
allow(nil).to receive(:find_by_name).with("Author Feedback").and_return(nil)
get "go_to_menu_items", params1: "Author feedbacks"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Global surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Global Survey").and_return(nil)
get "go_to_menu_items", params1: "Global surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Course evaluations and redirect to list" do
allow(nil).to receive(:find_by_name).with("Course Evaluation").and_return(nil)
get "go_to_menu_items", params1: "Course evaluations"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Survey").and_return(nil)
get "go_to_menu_items", params1: "Surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should redirect to root_url if request parameter is invalid" do
allow(nil).to receive(:find_by_name).with(nil).and_return(nil)
get "go_to_menu_items"
expect(response).to redirect_to(root_path)
end
end
describe "#drill" do
it "redirect to list action" do
get "drill" , root: 1
session[:root].should == "1"
expect(response).to redirect_to(list_tree_display_index_path)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-11-06T22:38:10Z

Abonam: /* Checking the direct access tabs from navigation bar */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng

|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

==='''How to test the changes from UI'''===

{| class="wikitable"
|-
|
* Login in as an instructor or admin using credentials (admin with password: admin or instructor6 with password: password)
* To check the changes made in go_to_menu_items method, hover over the Manage tab in the navigation bar on the top and click all the links and check whether they are being redirected to correct pages. For example, if Questionnaires is clicked, you should be | redirected directly to the page displaying all the questionnaires with its sub-categories like Reviews, Surveys etc.
* To test the changes made in get_children_node_ng and get_children_node_2_ng methods, click on the sub categories under each of the parent tree displays (Courses, Assignments and Questionnaires) and all of them will further expand to show the details.
|-
|}

=Login using Instructor Credentials=
[[File:Example.jpg]]

=Checking the direct access tabs from navigation bar=
[[File:Tree screenshot.png]]

=Checking the sub categories in each parent Tree=
[[File:Example.jpg]]

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end

describe "#go_to_menu_items" do
before do
allow(nil).to receive(:find_by_node_object_id).and_return(nil)
allow(nil).to receive(:id).and_return(nil)
allow(nil).to receive(:name).and_return(true)
end
it "should receive Review Rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Review").and_return(nil)
get "go_to_menu_items", params1: "Review Rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Teammate review rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Teammate review").and_return(nil)
get "go_to_menu_items", params1: "Teammate review rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Metareview rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Metareview").and_return(nil)
get "go_to_menu_items", params1: "Metareview rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Author feedbacks and redirect to list" do
allow(nil).to receive(:find_by_name).with("Author Feedback").and_return(nil)
get "go_to_menu_items", params1: "Author feedbacks"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Global surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Global Survey").and_return(nil)
get "go_to_menu_items", params1: "Global surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Course evaluations and redirect to list" do
allow(nil).to receive(:find_by_name).with("Course Evaluation").and_return(nil)
get "go_to_menu_items", params1: "Course evaluations"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Survey").and_return(nil)
get "go_to_menu_items", params1: "Surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should redirect to root_url if request parameter is invalid" do
allow(nil).to receive(:find_by_name).with(nil).and_return(nil)
get "go_to_menu_items"
expect(response).to redirect_to(root_path)
end
end
describe "#drill" do
it "redirect to list action" do
get "drill" , root: 1
session[:root].should == "1"
expect(response).to redirect_to(list_tree_display_index_path)
end
end
end
</pre>
}

=References=
<references></references>

File:Review rubrics screenshot.png

2015-11-06T22:32:29Z

Abonam:

File:Sub-tree screenshot.png

2015-11-06T22:27:57Z

Abonam:

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-11-06T16:57:57Z

Abonam: /* TreeDisplayController */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng

|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

==='''How to test the changes from UI'''===

{| class="wikitable"
|-
|
* Login in as an instructor or admin using credentials (admin with password: admin or instructor6 with password: password)
* To check the changes made in go_to_menu_items method, hover over the Manage tab in the navigation bar on the top and click all the links and check whether they are being redirected to correct pages. For example, if Questionnaires is clicked, you should be | redirected directly to the page displaying all the questionnaires with its sub-categories like Reviews, Surveys etc.
* To test the changes made in get_children_node_ng and get_children_node_2_ng methods, click on the sub categories under each of the parent tree displays (Courses, Assignments and Questionnaires) and all of them will further expand to show the details.
|-
|}

=Login using Instructor Credentials=
[[File:Example.jpg]]

=Checking the direct access tabs from navigation bar=
[[File:Example.jpg]]

=Checking the sub categories in each parent Tree=
[[File:Example.jpg]]

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end

describe "#go_to_menu_items" do
before do
allow(nil).to receive(:find_by_node_object_id).and_return(nil)
allow(nil).to receive(:id).and_return(nil)
allow(nil).to receive(:name).and_return(true)
end
it "should receive Review Rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Review").and_return(nil)
get "go_to_menu_items", params1: "Review Rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Teammate review rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Teammate review").and_return(nil)
get "go_to_menu_items", params1: "Teammate review rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Metareview rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Metareview").and_return(nil)
get "go_to_menu_items", params1: "Metareview rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Author feedbacks and redirect to list" do
allow(nil).to receive(:find_by_name).with("Author Feedback").and_return(nil)
get "go_to_menu_items", params1: "Author feedbacks"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Global surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Global Survey").and_return(nil)
get "go_to_menu_items", params1: "Global surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Course evaluations and redirect to list" do
allow(nil).to receive(:find_by_name).with("Course Evaluation").and_return(nil)
get "go_to_menu_items", params1: "Course evaluations"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Survey").and_return(nil)
get "go_to_menu_items", params1: "Surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should redirect to root_url if request parameter is invalid" do
allow(nil).to receive(:find_by_name).with(nil).and_return(nil)
get "go_to_menu_items"
expect(response).to redirect_to(root_path)
end
end
describe "#drill" do
it "redirect to list action" do
get "drill" , root: 1
session[:root].should == "1"
expect(response).to redirect_to(list_tree_display_index_path)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-11-06T16:54:27Z

Abonam: /* How to test the changes from UI */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

==='''How to test the changes from UI'''===

{| class="wikitable"
|-
|
* Login in as an instructor or admin using credentials (admin with password: admin or instructor6 with password: password)
* To check the changes made in go_to_menu_items method, hover over the Manage tab in the navigation bar on the top and click all the links and check whether they are being redirected to correct pages. For example, if Questionnaires is clicked, you should be | redirected directly to the page displaying all the questionnaires with its sub-categories like Reviews, Surveys etc.
* To test the changes made in get_children_node_ng and get_children_node_2_ng methods, click on the sub categories under each of the parent tree displays (Courses, Assignments and Questionnaires) and all of them will further expand to show the details.
|-
|}

=Login using Instructor Credentials=
[[File:Example.jpg]]

=Checking the direct access tabs from navigation bar=
[[File:Example.jpg]]

=Checking the sub categories in each parent Tree=
[[File:Example.jpg]]

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end

describe "#go_to_menu_items" do
before do
allow(nil).to receive(:find_by_node_object_id).and_return(nil)
allow(nil).to receive(:id).and_return(nil)
allow(nil).to receive(:name).and_return(true)
end
it "should receive Review Rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Review").and_return(nil)
get "go_to_menu_items", params1: "Review Rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Teammate review rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Teammate review").and_return(nil)
get "go_to_menu_items", params1: "Teammate review rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Metareview rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Metareview").and_return(nil)
get "go_to_menu_items", params1: "Metareview rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Author feedbacks and redirect to list" do
allow(nil).to receive(:find_by_name).with("Author Feedback").and_return(nil)
get "go_to_menu_items", params1: "Author feedbacks"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Global surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Global Survey").and_return(nil)
get "go_to_menu_items", params1: "Global surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Course evaluations and redirect to list" do
allow(nil).to receive(:find_by_name).with("Course Evaluation").and_return(nil)
get "go_to_menu_items", params1: "Course evaluations"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Survey").and_return(nil)
get "go_to_menu_items", params1: "Surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should redirect to root_url if request parameter is invalid" do
allow(nil).to receive(:find_by_name).with(nil).and_return(nil)
get "go_to_menu_items"
expect(response).to redirect_to(root_path)
end
end
describe "#drill" do
it "redirect to list action" do
get "drill" , root: 1
session[:root].should == "1"
expect(response).to redirect_to(list_tree_display_index_path)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-11-06T16:25:30Z

Abonam: /* How to test the changes from UI */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

==How to test the changes from UI==

{| class="wikitable"
|-
|
* Login in as an instructor or admin using credentials (admin with password: admin or instructor6 with password: password)
* To check the changes made in go_to_menu_items method, hover over the Manage tab in the navigation bar on the top and click all the links and check whether they are being redirected to correct pages. For example, if Questionnaires is clicked, you should be | redirected directly to the page displaying all the questionnaires with its sub-categories like Reviews, Surveys etc.
* To test the changes made in get_children_node_ng and get_children_node_2_ng methods, click on the sub categories under each of the parent tree displays (Courses, Assignments and Questionnaires) and all of them will further expand to show the details.
|-
|}

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end

describe "#go_to_menu_items" do
before do
allow(nil).to receive(:find_by_node_object_id).and_return(nil)
allow(nil).to receive(:id).and_return(nil)
allow(nil).to receive(:name).and_return(true)
end
it "should receive Review Rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Review").and_return(nil)
get "go_to_menu_items", params1: "Review Rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Teammate review rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Teammate review").and_return(nil)
get "go_to_menu_items", params1: "Teammate review rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Metareview rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Metareview").and_return(nil)
get "go_to_menu_items", params1: "Metareview rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Author feedbacks and redirect to list" do
allow(nil).to receive(:find_by_name).with("Author Feedback").and_return(nil)
get "go_to_menu_items", params1: "Author feedbacks"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Global surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Global Survey").and_return(nil)
get "go_to_menu_items", params1: "Global surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Course evaluations and redirect to list" do
allow(nil).to receive(:find_by_name).with("Course Evaluation").and_return(nil)
get "go_to_menu_items", params1: "Course evaluations"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Survey").and_return(nil)
get "go_to_menu_items", params1: "Surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should redirect to root_url if request parameter is invalid" do
allow(nil).to receive(:find_by_name).with(nil).and_return(nil)
get "go_to_menu_items"
expect(response).to redirect_to(root_path)
end
end
describe "#drill" do
it "redirect to list action" do
get "drill" , root: 1
session[:root].should == "1"
expect(response).to redirect_to(list_tree_display_index_path)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-11-06T14:49:58Z

Abonam: /* How to test the changes from UI */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

==How to test the changes from UI==

{| class="wikitable"
|-
|
* Login in as an instructor or admin using credentials (admin with password: admin or instructor6 with password: password)
* Hover over the Manage tab in the navigation bar on the top and click all the links and check whether they are being redirected to correct pages. For example, if Questionnaires is clicked, you should be | redirected directly to the page displaying all the questionnaires with its sub-categories like Reviews, Surveys etc.
|-
|}

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end

describe "#go_to_menu_items" do
before do
allow(nil).to receive(:find_by_node_object_id).and_return(nil)
allow(nil).to receive(:id).and_return(nil)
allow(nil).to receive(:name).and_return(true)
end
it "should receive Review Rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Review").and_return(nil)
get "go_to_menu_items", params1: "Review Rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Teammate review rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Teammate review").and_return(nil)
get "go_to_menu_items", params1: "Teammate review rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Metareview rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Metareview").and_return(nil)
get "go_to_menu_items", params1: "Metareview rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Author feedbacks and redirect to list" do
allow(nil).to receive(:find_by_name).with("Author Feedback").and_return(nil)
get "go_to_menu_items", params1: "Author feedbacks"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Global surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Global Survey").and_return(nil)
get "go_to_menu_items", params1: "Global surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Course evaluations and redirect to list" do
allow(nil).to receive(:find_by_name).with("Course Evaluation").and_return(nil)
get "go_to_menu_items", params1: "Course evaluations"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Survey").and_return(nil)
get "go_to_menu_items", params1: "Surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should redirect to root_url if request parameter is invalid" do
allow(nil).to receive(:find_by_name).with(nil).and_return(nil)
get "go_to_menu_items"
expect(response).to redirect_to(root_path)
end
end
describe "#drill" do
it "redirect to list action" do
get "drill" , root: 1
session[:root].should == "1"
expect(response).to redirect_to(list_tree_display_index_path)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-11-06T14:49:07Z

Abonam: /* MenuItemsController */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

==How to test the changes from UI==

{| class="wikitable"
|-
|* Login in as an instructor or admin using credentials (admin with password: admin or instructor6 with password: password)
|* Hover over the Manage tab in the navigation bar on the top and click all the links and check whether they are being redirected to correct pages. For example, if Questionnaires is clicked, you should be | redirected directly to the page displaying all the questionnaires with its sub-categories like Reviews, Surveys etc.
|-
|}

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end

describe "#go_to_menu_items" do
before do
allow(nil).to receive(:find_by_node_object_id).and_return(nil)
allow(nil).to receive(:id).and_return(nil)
allow(nil).to receive(:name).and_return(true)
end
it "should receive Review Rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Review").and_return(nil)
get "go_to_menu_items", params1: "Review Rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Teammate review rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Teammate review").and_return(nil)
get "go_to_menu_items", params1: "Teammate review rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Metareview rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Metareview").and_return(nil)
get "go_to_menu_items", params1: "Metareview rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Author feedbacks and redirect to list" do
allow(nil).to receive(:find_by_name).with("Author Feedback").and_return(nil)
get "go_to_menu_items", params1: "Author feedbacks"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Global surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Global Survey").and_return(nil)
get "go_to_menu_items", params1: "Global surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Course evaluations and redirect to list" do
allow(nil).to receive(:find_by_name).with("Course Evaluation").and_return(nil)
get "go_to_menu_items", params1: "Course evaluations"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Survey").and_return(nil)
get "go_to_menu_items", params1: "Surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should redirect to root_url if request parameter is invalid" do
allow(nil).to receive(:find_by_name).with(nil).and_return(nil)
get "go_to_menu_items"
expect(response).to redirect_to(root_path)
end
end
describe "#drill" do
it "redirect to list action" do
get "drill" , root: 1
session[:root].should == "1"
expect(response).to redirect_to(list_tree_display_index_path)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-10-31T15:08:08Z

Abonam:

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end

describe "#go_to_menu_items" do
before do
allow(nil).to receive(:find_by_node_object_id).and_return(nil)
allow(nil).to receive(:id).and_return(nil)
allow(nil).to receive(:name).and_return(true)
end
it "should receive Review Rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Review").and_return(nil)
get "go_to_menu_items", params1: "Review Rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Teammate review rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Teammate review").and_return(nil)
get "go_to_menu_items", params1: "Teammate review rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Metareview rubrics and redirect to list" do
allow(nil).to receive(:find_by_name).with("Metareview").and_return(nil)
get "go_to_menu_items", params1: "Metareview rubrics"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Author feedbacks and redirect to list" do
allow(nil).to receive(:find_by_name).with("Author Feedback").and_return(nil)
get "go_to_menu_items", params1: "Author feedbacks"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Global surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Global Survey").and_return(nil)
get "go_to_menu_items", params1: "Global surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Course evaluations and redirect to list" do
allow(nil).to receive(:find_by_name).with("Course Evaluation").and_return(nil)
get "go_to_menu_items", params1: "Course evaluations"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should receive Surveys and redirect to list" do
allow(nil).to receive(:find_by_name).with("Survey").and_return(nil)
get "go_to_menu_items", params1: "Surveys"
expect(response).to redirect_to(list_tree_display_index_path)
end
it "should redirect to root_url if request parameter is invalid" do
allow(nil).to receive(:find_by_name).with(nil).and_return(nil)
get "go_to_menu_items"
expect(response).to redirect_to(root_path)
end
end
describe "#drill" do
it "redirect to list action" do
get "drill" , root: 1
session[:root].should == "1"
expect(response).to redirect_to(list_tree_display_index_path)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-10-30T15:52:39Z

Abonam: /* Removing duplicate methods */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end

describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-10-30T15:52:12Z

Abonam: /* Removing duplicate methods */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==
Anush For u to write here...
{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end
node_object = TreeFolder.find_by_name(name)
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif (node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||
node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9||
node_object.id ==10) # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'
else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end

describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-10-30T15:48:33Z

Abonam: /* Removing duplicate methods */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==
Anush For u to write here...
{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
# direct access to questionnaires
def goto_questionnaires
node_object = TreeFolder.find_by_name('Questionnaires')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to review rubrics
def goto_review_rubrics
node_object = TreeFolder.find_by_name('Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to metareview rubrics
def goto_metareview_rubrics
node_object = TreeFolder.find_by_name('Metareview')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to teammate review rubrics
def goto_teammatereview_rubrics
node_object = TreeFolder.find_by_name('Teammate Review')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to author feedbacks
def goto_author_feedbacks
node_object = TreeFolder.find_by_name('Author Feedback')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to global survey
def goto_global_survey
node_object = TreeFolder.find_by_name('Global Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to surveys
def goto_surveys
node_object = TreeFolder.find_by_name('Survey')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to course evaluations
def goto_course_evaluations
node_object = TreeFolder.find_by_name('Course Evaluation')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to courses
def goto_courses
node_object = TreeFolder.find_by_name('Courses')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end

# direct access to assignments
def goto_assignments
node_object = TreeFolder.find_by_name('Assignments')
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
redirect_to :controller => 'tree_display', :action => 'list'
end
</pre>
|<pre>
# direct access
def go_to_menu_items
name = params[:params1]
if name
if name == "Review rubrics"
name = "Review"
elsif name == "Teammate review rubrics"
name = "Teammate Review"
elsif name == "Metareview rubrics"
name = "Metareview"
elsif name == "Author feedbacks"
name = "Author Feedback"
elsif name == "Global surveys"
name = "Global Survey"
elsif name == "Course evaluations"
name = "Course Evaluation"
elsif name == "Surveys"
name = "Survey"
end

node_object = TreeFolder.find_by_name(name)
puts node_object.inspect
session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
if node_object.name == "Courses"
session[:last_open_tab] = 1
elsif node_object.name == "Assignments"
session[:last_open_tab] = 2
elsif node_object.id ==1 ||node_object.id ==4 ||node_object.id ==5 ||node_object.id ==6 ||node_object.id ==7 ||node_object.id ==8 ||node_object.id ==9 ||node_object.id ==10 # if node_object_name is Questionnaires or its child_nodes
session[:last_open_tab] = 3 # for Questionnaires and all its childnodes
end
redirect_to :controller => 'tree_display', :action => 'list'

else # if the passed params is null, redirect to root
redirect_to "/"
end
</pre>
|- style="vertical-align:bottom;"
|}

==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end

describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-10-30T15:40:52Z

Abonam: /* Problem Statement */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''Controller Responsibilities:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''Bad practices followed:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''Refactoring to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.
# Merge all the repeating methods into a single method.
# Write functional tests for the TreeDispayController.
# Remove commented code in list method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==
Anush For u to write here...
{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.map_id, :return => "feedback"
else
redirect_to :back
end
end

def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
#if no feedback exists by dat user den only create for dat particular response/review
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.id, :return => "feedback"
else
redirect_to :back
end
end
</pre>
|<pre>
def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
#if no feedback exists by dat user den only create for dat particular response/review
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.id, :return => "feedback"
else
redirect_to :back
end
end
</pre>
|- style="vertical-align:bottom;"
|<pre>
def view
@response = Response.find(params[:id])
return if redirect_when_disallowed(@response)
@map = @response.map
get_content
@review_scores = Array.new
@question_type = Array.new
@questions.each do |question|
@review_scores << Score.where(response_id: @map.response_id, question_id: question.id).first
@question_type << QuestionType.find_by_question_id(question.id)
end
end

def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|<pre>
def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|}
==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end

describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-10-30T15:29:01Z

Abonam: /* Rspec Test */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''What they do:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''What's wrong with it:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''What needs to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==
Anush For u to write here...
{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.map_id, :return => "feedback"
else
redirect_to :back
end
end

def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
#if no feedback exists by dat user den only create for dat particular response/review
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.id, :return => "feedback"
else
redirect_to :back
end
end
</pre>
|<pre>
def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
#if no feedback exists by dat user den only create for dat particular response/review
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.id, :return => "feedback"
else
redirect_to :back
end
end
</pre>
|- style="vertical-align:bottom;"
|<pre>
def view
@response = Response.find(params[:id])
return if redirect_when_disallowed(@response)
@map = @response.map
get_content
@review_scores = Array.new
@question_type = Array.new
@questions.each do |question|
@review_scores << Score.where(response_id: @map.response_id, question_id: question.id).first
@question_type << QuestionType.find_by_question_id(question.id)
end
end

def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|<pre>
def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|}
==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do

describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end

describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
allow(session[:user]).to receive("ta?").and_return(true)
end
end

describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end

describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-10-30T15:14:01Z

Abonam:

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''What they do:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''What's wrong with it:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''What needs to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-
|}

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==
Anush For u to write here...
{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.map_id, :return => "feedback"
else
redirect_to :back
end
end

def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
#if no feedback exists by dat user den only create for dat particular response/review
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.id, :return => "feedback"
else
redirect_to :back
end
end
</pre>
|<pre>
def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
#if no feedback exists by dat user den only create for dat particular response/review
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.id, :return => "feedback"
else
redirect_to :back
end
end
</pre>
|- style="vertical-align:bottom;"
|<pre>
def view
@response = Response.find(params[:id])
return if redirect_when_disallowed(@response)
@map = @response.map
get_content
@review_scores = Array.new
@question_type = Array.new
@questions.each do |question|
@review_scores << Score.where(response_id: @map.response_id, question_id: question.id).first
@question_type << QuestionType.find_by_question_id(question.id)
end
end

def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|<pre>
def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|}
==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do
describe "#get_children_node_ng" do
end
describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
end
end
describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end
describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-10-30T15:13:11Z

Abonam: /* MenuItemsController */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''What they do:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''What's wrong with it:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''What needs to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|------

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==
Anush For u to write here...
{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.map_id, :return => "feedback"
else
redirect_to :back
end
end

def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
#if no feedback exists by dat user den only create for dat particular response/review
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.id, :return => "feedback"
else
redirect_to :back
end
end
</pre>
|<pre>
def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
#if no feedback exists by dat user den only create for dat particular response/review
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.id, :return => "feedback"
else
redirect_to :back
end
end
</pre>
|- style="vertical-align:bottom;"
|<pre>
def view
@response = Response.find(params[:id])
return if redirect_when_disallowed(@response)
@map = @response.map
get_content
@review_scores = Array.new
@question_type = Array.new
@questions.each do |question|
@review_scores << Score.where(response_id: @map.response_id, question_id: question.id).first
@question_type << QuestionType.find_by_question_id(question.id)
end
end

def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|<pre>
def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|}
==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do
describe "#get_children_node_ng" do
end
describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
end
end
describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end
describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end
end
</pre>
}

=References=
<references></references>

CSC/ECE 517 Fall 2015/oss E1570 avr

2015-10-30T15:12:29Z

Abonam: /* TreeDisplayController */

'''E1570. Refactoring TreeDisplayController'''

This page provides a description of the Expertiza based OSS project. This project aimed at refactoring the TreeDisplayController.

__TOC__

=Introduction to Expertiza=
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref><ref>[http://wikis.lib.ncsu.edu/index.php/Expertiza Wiki]</ref>

= Problem Statement =
'''Classes involved:'''
tree_display_controller.rb

'''What they do:'''
This controller deals with displaying “trees” of objects to the instructor. When an instructor logs in, (s)he is greeted with a homepage that lists questionnaires (rubrics, quizzes, surveys), courses, and assignments. These objects are displayed in a “tree,” allowing the user to click on the top-level object and see the objects beneath it.

'''What's wrong with it:'''
* Many Duplicate Methods.
* Very Long Methods combining many Functionalities.
* Redundant methods not being used anywhere.

'''What needs to be done:'''
# Split get_children_node_ng and get_children_node_2_ng into smaller methods and give reasonable names to them and make sure implement common code in a single method.

=Changes Made=

==TreeDisplayController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| goto_questionnaires, goto_review_rubrics, goto_metareview_rubrics, goto_teammatereview_rubrics, goto_author_feedbacks, goto_global_survey, goto_surveys, goto_course_evaluations, goto_courses, goto_assignments
| All these methods were merged into a single method with name go_to_menu_items which receives a parameter of the name of tree_folder object, such as "Questionnaires".
|Since all the methods were performing the same action, i.e passing the node object id to list method in TreeDisplayController, the name is passed a parameter to the go_to_menu_items method from "link" method in MenuItemsController. Using this parameter the respective object and its ID are found and is redirected to "list" method.
|-
| get_children_node_ng
| rowspan="2" | Moved part of the code from these methods to newly created methods populate_rows,display_row,page_render methods.
| rowspan="2" | These Methods had many functionalities being implemented which made the method look lengthy and moreover these methods were performing almost similar functions which could be grouped together and reduce the overall code length.
|-
| get_children_node_2_ng
|-
| Put ur method here
| Put ur txt here
| put ur text here
|-
|}

==MenuItemsController==

{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
|-------
| link
| Redirect url only for the menu_items altered in TreeDisplayController is changed to go_to_menu_items_url.
| Since the 10 methods had been merged into one method in TreeDisplayController, the redirect url is set to go_to_menu_items url.
|-

= Re-factored Code =

==Refactoring get_children_node_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
tmpRes = {}
res = {}
for node in childNodes
fnode = eval(params[:reactParams][:nodeType]).new

for a in node
fnode[a[0]] = a[1]
end

# fnode is the parent node
# ch_nodes are childrens
ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes[fnode.get_name] = ch_nodes

# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)

end

for nodeType in tmpRes.keys
res[nodeType] = Array.new

for node in tmpRes[nodeType]
tmpObject = {}
tmpObject["nodeinfo"] = node
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type

if nodeType == 'Courses' || nodeType == "Assignments"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&

Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if nodeType == "Assignments"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
res[nodeType] << tmpObject
end

end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_ng
childNodes = {}
if params[:reactParams][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams][:child_nodes])
else
childNodes = params[:reactParams][:child_nodes]
end
ch_nodes = {}
for node in childNodes
# Declaring Foldernode Object as New
fnode = eval(params[:reactParams][:nodeType]).new
for a in node
fnode[a[0]] = a[1]
end
# fnode is the parent node
# ch_nodes are childrens
ch_nodes[fnode.get_name] = fnode.get_children(nil, nil, session[:user].id, nil, nil)
# cnode = fnode.get_children("created_at", "desc", 2, nil, nil)
end
call_function ="get_children_node_ng"
#Render JSON of the child nodes
populate_rows(ch_nodes,call_function)
end
</pre>
|}

==Refactoring get_children_node_2_ng method==

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def get_children_node_2_ng
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end
tmpRes = {}
res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)
tmpRes = ch_nodes
if tmpRes
for child in tmpRes
nodeType = child.type
res2 = {}
res2["nodeinfo"] = child
res2["name"] = child.get_name
res2["key"] = params[:reactParams2][:key]
res2["type"] = nodeType

res2["private"] = child.get_private
res2["creation_date"] = child.get_creation_date
res2["updated_date"] = child.get_modified_date
if nodeType == 'CourseNode' || nodeType == "AssignmentNode"
res2["directory"] = child.get_directory
instructor_id = child.get_instructor_id
res2["instructor_id"] = instructor_id
unless (instructor_id.nil?)
res2["instructor"] = User.find(instructor_id).name
else
res2["instructor"] = nil
end

res2["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 &&
Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(child))
if nodeType == "AssignmentNode"
res2["course_id"] = child.get_course_id
res2["max_team_size"] = child.get_max_team_size
res2["is_intelligent"] = child.get_is_intelligent
res2["require_quiz"] = child.get_require_quiz
res2["allow_suggestions"] = child.get_allow_suggestions
res2["has_topic"] = SignUpTopic.where(['assignment_id = ?', child.node_object_id]).first ? true : false
end
end
res << res2
end
end

respond_to do |format|
format.html {render json: res}
end
end
</pre>
|<pre>
def get_children_node_2_ng
# Second Level of Tree Display with Children Nodes
childNodes = {}
if params[:reactParams2][:child_nodes].is_a? String
childNodes = JSON.parse(params[:reactParams2][:child_nodes])
else
childNodes = params[:reactParams2][:child_nodes]
end

res = []
fnode = eval(params[:reactParams2][:nodeType]).new
childNodes.each do |key, value|
fnode[key] = value
end

ch_nodes = fnode.get_children(nil, nil, session[:user].id, nil, nil)

call_function = "get_children_node_2_ng"
populate_rows(ch_nodes, call_function)
end
</pre>
|}

==Common Methods Added to get_children_node_ng and get_children_node_2_ng controllers ==

===populate_rows ===

This is a new Common Method for both get_children_node_ng and get_children_node_2_ng that does the functionality of rendering a page with data from all nodes by calling another method populate_1_row(). There is another Method call that happens in this method which as a whole renders the List View.

{| class="wikitable"

! |populate_rows()
|- style="vertical-align:top;"
|<pre>
def populate_rows(list,call_function) #render page with data for all nodes in list
if call_function == "get_children_node_ng"
tmpRes ={}
tmpRes = list
res = {}
for nodeType in tmpRes.keys
# declaring a new array
res[nodeType] = Array.new
for node in tmpRes[nodeType]
res[nodeType] << populate_1_row(node)
end
end

else
tmpRes = list
res = []
if tmpRes
for child in tmpRes
res2 = {}
res2 = populate_1_row(child)
res2["key"] = params[:reactParams2][:key]
res << res2
end
end
end
page_render(res)
end
</pre>
}

===populate_1_row ===

This is a new Method that is called from Method populate_row() and fetches all the child node names from respective Controller actions and then populates the tmpObject.

{| class="wikitable"
|-
! |populate_1_row()
|- style="vertical-align:top;"
|<pre>
def populate_1_row(node) #return JSON for 1 Node
tmpObject = {}
tmpObject["nodeinfo"] = node
# all the child nodes names got and put in tmpObject from respective controller actions
tmpObject["name"] = node.get_name
tmpObject["type"] = node.type
if node.type == 'CourseNode' || node.type == "AssignmentNode"
tmpObject["directory"] = node.get_directory
tmpObject["creation_date"] = node.get_creation_date
tmpObject["updated_date"] = node.get_modified_date
tmpObject["private"] = node.get_private
instructor_id = node.get_instructor_id
tmpObject["instructor_id"] = instructor_id
unless (instructor_id.nil?)
tmpObject["instructor"] = User.find(instructor_id).name
else
tmpObject["instructor"] = nil
end

tmpObject["is_available"] = is_available(session[:user], instructor_id) || (session[:user].role_id == 6 && Ta.get_my_instructors(session[:user].id).include?(instructor_id) && ta_for_current_course?(node))
if node.type == "AssignmentNode"
tmpObject["course_id"] = node.get_course_id
tmpObject["max_team_size"] = node.get_max_team_size
tmpObject["is_intelligent"] = node.get_is_intelligent
tmpObject["require_quiz"] = node.get_require_quiz
tmpObject["allow_suggestions"] = node.get_allow_suggestions
tmpObject["has_topic"] = SignUpTopic.where(['assignment_id = ?', node.node_object_id]).first ? true : false
end
end
tmpObject
end
</pre>
}

===page_render ===

This is also a common Method which integrates the rendering functionality of get_children_node_ng and get_children_node_2_ng making sure both levels are properly populated in the view.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
def page_render(list) # Common Render Functionality for get_children_node_ng and get_children_node_2_ng methods
respond_to do |format|
format.html {render json: list}
end
end
</pre>
}

== Method Removal==
There was a Method which dint have any Routes defined in the Routes.rb file and was not called in any of the Controller . After Careful analysis we descided to remove the method from the tree Display Controller.

=== filter ===

{| class="wikitable"
|-
! |filter
|- style="vertical-align:top;"
|<pre>
def filter
search = params[:filter_string]
filter_node = params[:filternode]
qid = 'filter+'

if filter_node == 'QAN'
assignment = Assignment.find_by_name(search)
if assignment
assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: assignment.id)
if assignment_questionnaires
assignment_questionnaires.each { |q| qid << "#{q.questionnaire_id.to_s}+" }
session[:root] = 1
end
end
elsif filter_node == 'ACN'
session[:root] = 2
qid << search
end
return qid
end
</pre>
}

==Removing duplicate methods==
Anush For u to write here...
{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:bottom;"
|<pre>
def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.map_id, :return => "feedback"
else
redirect_to :back
end
end

def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
#if no feedback exists by dat user den only create for dat particular response/review
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.id, :return => "feedback"
else
redirect_to :back
end
end
</pre>
|<pre>
def new_feedback
review = Response.find(params[:id])
if review
reviewer = AssignmentParticipant.where(user_id: session[:user].id, parent_id: review.map.assignment.id).first
map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: reviewer.id).first
if map.nil?
#if no feedback exists by dat user den only create for dat particular response/review
map = FeedbackResponseMap.create(:reviewed_object_id => review.id, :reviewer_id => reviewer.id,
:reviewee_id => review.map.reviewer.id)
end
redirect_to :action => 'new', :id => map.id, :return => "feedback"
else
redirect_to :back
end
end
</pre>
|- style="vertical-align:bottom;"
|<pre>
def view
@response = Response.find(params[:id])
return if redirect_when_disallowed(@response)
@map = @response.map
get_content
@review_scores = Array.new
@question_type = Array.new
@questions.each do |question|
@review_scores << Score.where(response_id: @map.response_id, question_id: question.id).first
@question_type << QuestionType.find_by_question_id(question.id)
end
end

def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|<pre>
def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|}
==Rspec Test==

We have written Rspec tests for the tree_display_controller and have run the same with success.

{| class="wikitable"
|-
! |page_render()
|- style="vertical-align:top;"
|<pre>
require 'rails_helper'

describe TreeDisplayController do
describe "#get_children_node_ng" do
end
describe "#list" do
it "should not redirect to student_task controller if current user is an instructor" do
allow(session[:user]).to receive("student?").and_return(false)
post "list"
response.should_not redirect_to(list_student_task_index_path)
end
it "should redirect to student_task controller if current user is a student" do
allow(session[:user]).to receive("student?").and_return(true)
post "list"
response.should redirect_to(list_student_task_index_path)
end
end
describe "#ta_for_current_mappings?" do
it "should return true if current user is a TA for current course" do
end
end
describe "#populate_rows" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_rows).with(Hash, String)}
it "passes when the arguments match" do
dbl.populate_rows({},"")
end
end
describe "#populate_1_row" do
let(:dbl) { double }
before { expect(dbl).to receive(:populate_1_row).with(Node) }
it "passes when the arguments match" do
dbl.populate_1_row(Node.new)
end
end
end
</pre>
}

=References=
<references></references>