Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-06T04:43:06Z

Sfernan2: /* Conclusion */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=Setup - How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ our Expertiza project running on AWS]

2) Login as Admin<br>
'''User:''' user2<br>
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include:
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Combined all of the goto methods
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Ensuring that instantiation of instance variables is minimized.

==1) Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==2) Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==3) Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new', :private => 0'' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>

'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==4) Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

The following was added to the ''index'' function of '''tree_display_controller.rb''' in order to replace the use of instance variables with local variables:
<pre>
locals search: @search,
sortvar: @sortvar,
sortorder: @sortorder,
root_node: @root_node,
child_nodes: @child_nodes,
filternode: params[:filternode],
searchnode: params[:searchnode]
</pre>

Many of the view files were changed to make use of the local variables.

Here is an example of how _bread_crumbs.html.erb was changed. Note the removal of the "@" characters.

'''Before:'''
<pre>
<% if @root_node %>
<%= link_to "Return to top", tree_display_index_path %>
<%
curr_node = @root_node
while curr_node.parent_id
curr_node = Node.find(curr_node.parent_id) %>
  
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
<% end %>
  <%= @root_node.get_name %><%
end %>
</pre>

'''After:'''
<pre>
<% if root_node %>
<%= link_to "Return to top", tree_display_index_path %>
<%
curr_node = root_node
while curr_node.parent_id
curr_node = Node.find(curr_node.parent_id) %>
  
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
<% end %>
  <%= root_node.get_name %><%
end %>
</pre>

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, ensured that instantiation of instance variables is minimized, and overall improved the quality and efficiency of the Expertiza codebase.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-06T04:41:47Z

Sfernan2: /* Refactoring TreeDisplayController Tasks */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=Setup - How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ our Expertiza project running on AWS]

2) Login as Admin<br>
'''User:''' user2<br>
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include:
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Combined all of the goto methods
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Ensuring that instantiation of instance variables is minimized.

==1) Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==2) Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==3) Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new', :private => 0'' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>

'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==4) Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

The following was added to the ''index'' function of '''tree_display_controller.rb''' in order to replace the use of instance variables with local variables:
<pre>
locals search: @search,
sortvar: @sortvar,
sortorder: @sortorder,
root_node: @root_node,
child_nodes: @child_nodes,
filternode: params[:filternode],
searchnode: params[:searchnode]
</pre>

Many of the view files were changed to make use of the local variables.

Here is an example of how _bread_crumbs.html.erb was changed. Note the removal of the "@" characters.

'''Before:'''
<pre>
<% if @root_node %>
<%= link_to "Return to top", tree_display_index_path %>
<%
curr_node = @root_node
while curr_node.parent_id
curr_node = Node.find(curr_node.parent_id) %>
  
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
<% end %>
  <%= @root_node.get_name %><%
end %>
</pre>

'''After:'''
<pre>
<% if root_node %>
<%= link_to "Return to top", tree_display_index_path %>
<%
curr_node = root_node
while curr_node.parent_id
curr_node = Node.find(curr_node.parent_id) %>
  
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
<% end %>
  <%= root_node.get_name %><%
end %>
</pre>

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-06T04:40:20Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=Setup - How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ our Expertiza project running on AWS]

2) Login as Admin<br>
'''User:''' user2<br>
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include:
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new', :private => 0'' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>

'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

The following was added to the ''index'' function of '''tree_display_controller.rb''' in order to replace the use of instance variables with local variables:
<pre>
locals search: @search,
sortvar: @sortvar,
sortorder: @sortorder,
root_node: @root_node,
child_nodes: @child_nodes,
filternode: params[:filternode],
searchnode: params[:searchnode]
</pre>

Many of the view files were changed to make use of the local variables.

Here is an example of how _bread_crumbs.html.erb was changed. Note the removal of the "@" characters.

'''Before:'''
<pre>
<% if @root_node %>
<%= link_to "Return to top", tree_display_index_path %>
<%
curr_node = @root_node
while curr_node.parent_id
curr_node = Node.find(curr_node.parent_id) %>
  
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
<% end %>
  <%= @root_node.get_name %><%
end %>
</pre>

'''After:'''
<pre>
<% if root_node %>
<%= link_to "Return to top", tree_display_index_path %>
<%
curr_node = root_node
while curr_node.parent_id
curr_node = Node.find(curr_node.parent_id) %>
  
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
<% end %>
  <%= root_node.get_name %><%
end %>
</pre>

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-06T04:40:03Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ our Expertiza project running on AWS]

2) Login as Admin<br>
'''User:''' user2<br>
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include:
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new', :private => 0'' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>

'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

The following was added to the ''index'' function of '''tree_display_controller.rb''' in order to replace the use of instance variables with local variables:
<pre>
locals search: @search,
sortvar: @sortvar,
sortorder: @sortorder,
root_node: @root_node,
child_nodes: @child_nodes,
filternode: params[:filternode],
searchnode: params[:searchnode]
</pre>

Many of the view files were changed to make use of the local variables.

Here is an example of how _bread_crumbs.html.erb was changed. Note the removal of the "@" characters.

'''Before:'''
<pre>
<% if @root_node %>
<%= link_to "Return to top", tree_display_index_path %>
<%
curr_node = @root_node
while curr_node.parent_id
curr_node = Node.find(curr_node.parent_id) %>
  
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
<% end %>
  <%= @root_node.get_name %><%
end %>
</pre>

'''After:'''
<pre>
<% if root_node %>
<%= link_to "Return to top", tree_display_index_path %>
<%
curr_node = root_node
while curr_node.parent_id
curr_node = Node.find(curr_node.parent_id) %>
  
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
<% end %>
  <%= root_node.get_name %><%
end %>
</pre>

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:52:36Z

Sfernan2: /* Use Routing Helpers */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ our Expertiza project running on AWS]

2) Login as Admin<br>
'''User:''' user2<br>
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include:
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new', :private => 0'' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>

'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:50:06Z

Sfernan2: /* How To View Our Expertiza Fork Running on AWS */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ our Expertiza project running on AWS]

2) Login as Admin<br>
'''User:''' user2<br>
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include:
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>

'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:47:58Z

Sfernan2: /* Combined All of the Goto Methods */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ our Expertiza project running on AWS]

2) Login as Admin
'''User:''' user2
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include:
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>

'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:47:47Z

Sfernan2: /* Use Routing Helpers */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ our Expertiza project running on AWS]

2) Login as Admin
'''User:''' user2
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include:
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>

'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:47:20Z

Sfernan2: /* Refactoring TreeDisplayController Tasks */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ our Expertiza project running on AWS]

2) Login as Admin
'''User:''' user2
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include:
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>
'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:46:35Z

Sfernan2: /* How To View Our Expertiza Fork Running on AWS */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ our Expertiza project running on AWS]

2) Login as Admin
'''User:''' user2
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>
'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:46:12Z

Sfernan2: /* How To View Our Expertiza Fork Running on AWS */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Expertiza project running on AWS]

2) Login as Admin
'''User:''' user2
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>
'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:45:48Z

Sfernan2: /* Project Links */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>

=How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Expertiza project running on AWS]<br>
2) Login as Admin
'''User:''' user2
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>
'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:45:40Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=How To View Our Expertiza Fork Running on AWS=
NOTE: The scope of our project was only to refactor select code. There are no feature additions or changes, so it should work just like production Expertiza.

1) Go to [http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Expertiza project running on AWS]<br>
2) Login as Admin
'''User:''' user2
'''Password:''' password

3) Click on "Manage..." if you are not automatically directed to the tree display.

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>
'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:41:24Z

Sfernan2: /* Changing List to Index */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>
'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:40:46Z

Sfernan2: /* Combined All of the Goto Methods */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>
'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:40:13Z

Sfernan2: /* Combined All of the Goto Methods */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb''':
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>
'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:40:02Z

Sfernan2: /* Combined All of the Goto Methods */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 very similar methods we removed from '''tree_display_controller.rb'''
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>
'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:39:42Z

Sfernan2: /* Combined All of the Goto Methods */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

Shown below are 3 of the 10 unnecessary methods we removed from '''tree_display_controller.rb'''
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>
'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:39:11Z

Sfernan2: /* Use Routing Helpers */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

3 of the 10 unnecessary methods removed from '''tree_display_controller.rb'''
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the tree display controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''' changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

Another example of routing helpers in '''_bread_crumbs.html.erb'''. <br>
'''Before:'''
<pre>
<%= link_to curr_node.get_name, :controller => 'tree_display', :action => 'drill', :root => curr_node.id %>
</pre>

'''After''':
<pre>
<%= link_to curr_node.get_name, tree_display_index_path(root: curr_node.id)%>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:34:59Z

Sfernan2: /* Use Routing Helpers */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

3 of the 10 unnecessary methods removed from '''tree_display_controller.rb'''
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. Our [https://github.com/Druotic/expertiza Github repo] shows all the changes made.

As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb'''changes:
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:34:37Z

Sfernan2: /* Conclusion */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

3 of the 10 unnecessary methods removed from '''tree_display_controller.rb'''
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. Our [https://github.com/Druotic/expertiza Github repo] shows all the changes made.

As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''':
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

=Conclusion=
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:34:20Z

Sfernan2: /* Changing List to Index */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to '''remove''' list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

3 of the 10 unnecessary methods removed from '''tree_display_controller.rb'''
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. Our [https://github.com/Druotic/expertiza Github repo] shows all the changes made.

As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''':
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

==Conclusion==
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T22:33:59Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to remove list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

3 of the 10 unnecessary methods removed from '''tree_display_controller.rb'''
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

'''Added''' variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

'''Removed''' goto_assignments method:
<pre>
- # 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>

'''Added''' index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. Our [https://github.com/Druotic/expertiza Github repo] shows all the changes made.

As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''':
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

==Conclusion==
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T21:00:26Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to remove list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

3 of the 10 unnecessary methods removed from '''tree_display_controller.rb'''
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

Added variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

Removed goto_assignments method:
<pre>
- # 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>

Added index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. Our [https://github.com/Druotic/expertiza Github repo] shows all the changes made.

As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''':
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

==Use {} and [] instead of Hash.new and Array.new==

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

==Conclusion==
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:56:51Z

Sfernan2: /* Conclusion */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to remove list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

3 of the 10 unnecessary methods removed from '''tree_display_controller.rb'''
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

Added variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

Removed goto_assignments method:
<pre>
- # 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>

Added index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. Our [https://github.com/Druotic/expertiza Github repo] shows all the changes made.

As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''':
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

==Conclusion==
In conclusion, we were able to successfully refactor the tree_display_controller and related controllers and views. We improved and expanded the use of RESTful and DRY design choices, implemented the use of routing helpers, used {} and [] instead of Hash.new and Array.new, and ensured that instantiation of instance variables is minimized.

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:53:29Z

Sfernan2: /* Combined All of the Goto Methods */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to remove list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

3 of the 10 unnecessary methods removed from '''tree_display_controller.rb'''
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

Added variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

Removed goto_assignments method:
<pre>
- # 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>

Added index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. Our [https://github.com/Druotic/expertiza Github repo] shows all the changes made.

As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''':
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

==Conclusion==

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:53:11Z

Sfernan2: /* Use Routing Helpers */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[https://github.com/expertiza/expertiza/pull/449 Expertize Pull Request] <br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account login details : <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=

As part of the refactoring task, we had to address the following issues for enhancing code readability and maintainability. The tasks include-
#Changing List to Index using a [http://www.restapitutorial.com/lessons/whatisrest.html RESTful] approach.
#Use of [http://guides.rubyonrails.org/routing.html#path-and-url-helpers routing helpers]
#Use {} and [] instead of Hash.new and Array.new
#Ensuring that instantiation of instance variables is minimized.

==Changing List to Index==

In order to make the codebase more [http://www.restapitutorial.com/lessons/whatisrest.html RESTful], we have replaced all the controller action redirections with a tree_display_index_path which enormously reduces the code content and as well as provides an organized approach to action redirections.

[[File:List_to_Index.png]]

As seen below, we were able to remove list from the Routes.rb:
<pre>
resources :tree_display do
collection do
get ':action'
- post 'list'
end
end
</pre>

==Combined All of the Goto Methods==
We also combined all of the goto methods into one, in accordance with the [http://en.wikipedia.org/wiki/Don't_repeat_yourself DRY] principle. This removed a significant amount of duplicate code.

3 of the 10 unnecessary methods removed from tree_display_controller.rb
<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
</pre>

These methods were replaced by a variable containing a list mapping of all the session variable strings to database labels. The goto_assignments method was replaced with an index method to accept this variable, rather then calling each goto method individually.

Added variable:
<pre>
+ @@Groups = {
+ 'Questionnaires' => 'Questionnaires',
+ 'Review rubrics' => 'Review',
+ 'Metareview rubrics' => 'Metareview',
+ 'Teammate review rubrics' => 'Teammate Review',
+ 'Author feedbacks' => 'Author Feedback',
+ 'Global survey' => 'Global Survey',
+ 'Surveys' => 'Survey',
+ 'Course evaluations' => 'Course Evaluation',
+ 'Courses' => 'Courses',
+ 'Bookmarkrating' => 'Bookmarkrating',
+ 'Assignments' => 'Assignments'
+ }
</pre>

Removed goto_assignments method:
<pre>
- # 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>

Added index method:
<pre>
+ def index
+ session[:root] = params[:root]
+ group = getGroup session[:menu]
+ node_object = TreeFolder.find_by_name(group)
+ if not group.blank? and not node_object.blank?
+ session[:root] = FolderNode.find_by_node_object_id(node_object.id).id
+ end
</pre>

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. Our [https://github.com/Druotic/expertiza Github repo] shows all the changes made.

As seen below, we utilized routing helpers and replaced '' ':controller=>'course', :action=>'new' '' with ''new_course_path(private: 0)''.

'''_courses_folder_actions.html.erb''':
<pre>
<ul>
<div>
<%= link_to image_tag('/assets/tree_view/add-public-24.png'),
- { :controller=>'course', :action=>'new', :private => 0 },
- { :title => 'Create Public Course', id: 'create-public-course' } %>
+ new_course_path(private: 0),
+ { title: 'Create Public Course', id: 'create-public-course' } %>
<%= link_to image_tag('/assets/tree_view/add-private-24.png'),
- { :controller=>'course', :action=>'new', :private => 1 },
- { :title => 'Create Private Course', id: 'create-private-course' } %>
+ new_course_path(private: 1),
+ { title: 'Create Private Course', id: 'create-private-course' } %>
</div>
</ul>
</li>
</ul>
</pre>

==Minimizing the count of Instance Variables==
=== Instance Variables in Ruby ===
An instance variable has a name beginning with @, and its scope is confined to whatever object self refers to. Two different objects, even if they belong to the same class, are allowed to have different values for their instance variables. From outside the object, instance variables cannot be altered or even observed (i.e., ruby's instance variables are never public) except by whatever methods are explicitly provided by the programmer. As with globals, instance variables have the nil value until they are initialized.

Instance variables do not need to be declared. This indicates a flexible object structure; in fact, each instance variable is dynamically appended to an object when it is first assigned.

We have observed that in Expertiza, there were several code files related to the Tree Display controller which were observed to be using multiple instance variables which could be reduced. Our team aimed to limit the instantiation of such variables to only necessary places in our code.

==Conclusion==

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:47:23Z

Sfernan2:

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:41:53Z

Sfernan2:

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:40:57Z

Sfernan2: /* Refactoring TreeDisplayController Tasks */

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:35:11Z

Sfernan2: /* Changing List to Index */

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:34:23Z

Sfernan2: /* Combined All of the Goto Methods */

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:34:01Z

Sfernan2: /* Combined All of the Goto Methods */

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:33:24Z

Sfernan2:

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:32:42Z

Sfernan2:

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-05T20:10:35Z

Sfernan2:

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-11-01T00:39:47Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]<br>
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Project Running on AWS]<br>
Admin Account: <br>
Username: user2 <br>
Password: password

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=
==combined all of the goto methods==

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. Our [https://github.com/Druotic/expertiza Github repo] shows all the changes made.

Example -- Route helpers added to breadcrumbs view file:
[[File:routehelpers.PNG ]]

==only use 1 instance variable in list method==

==look at the rest of the methods==

=Summary and Conclusions=
=Future Work=

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-10-31T22:55:29Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=
==combined all of the goto methods==

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similar. This involved many edits in the tree_display_controller.rb file and related controller and view files. Our [https://github.com/Druotic/expertiza Github repo] shows all the changes made.

Example -- Route helpers added to breadcrumbs view file:
[[File:routehelpers.PNG ]]

==only use 1 instance variable in list method==

==look at the rest of the methods==

=Summary and Conclusions=
=Future Work=

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-10-31T22:52:46Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=
==combined all of the goto methods==

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similiar.

Route helpers added to breadcrumbs view file:
[[File:routehelpers.PNG ]]

==only use 1 instance variable in list method==

==look at the rest of the methods==

=Summary and Conclusions=
=Future Work=

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-10-31T22:51:56Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display:
'''

=Refactoring TreeDisplayController Tasks=
==combined all of the goto methods==

==Use Routing Helpers==
We refactored the treedisplay controller class to use route helpers rather than calling ":action => 'list', :controller => 'tree_display'", or something similiar.

Route helpers added to breadcrumbs view file:
[[File:Expertiza.PNG ]]

==only use 1 instance variable in list method==

==look at the rest of the methods==

=Summary and Conclusions=
=Future Work=

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-10-31T22:43:23Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display
'''

Route helpers added to breadcrumbs
[[File:Expertiza.PNG ]]

=Refactoring TreeDisplayController Tasks=
==combined all of the goto methods==

==Use Routing Helpers==
Route helpers added to breadcrumbs
[[File:Routehelpers.PNG]]

==only use 1 instance variable in list method==

==look at the rest of the methods==

=Summary and Conclusions=
=Future Work=

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-10-31T22:43:14Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display
'''

Route helpers added to breadcrumbs
[[File:Exp.PNG ]]

=Refactoring TreeDisplayController Tasks=
==combined all of the goto methods==

==Use Routing Helpers==
Route helpers added to breadcrumbs
[[File:Routehelpers.PNG]]

==only use 1 instance variable in list method==

==look at the rest of the methods==

=Summary and Conclusions=
=Future Work=

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-10-31T22:41:41Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display
'''

Route helpers added to breadcrumbs
[[File:Routehelpers.PNG]]

=Refactoring TreeDisplayController Tasks=
==combined all of the goto methods==

==use routing helpers==

==only use 1 instance variable in list method==

==look at the rest of the methods==

=Summary and Conclusions=
=Future Work=

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-10-31T22:41:10Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display
'''

Route helpers added to breadcrumbs
[[File:expertiza.PNG]]

=Refactoring TreeDisplayController Tasks=
==combined all of the goto methods==

==use routing helpers==

==only use 1 instance variable in list method==

==look at the rest of the methods==

=Summary and Conclusions=
=Future Work=

File:Routehelpers.PNG

2014-10-31T22:39:08Z

Sfernan2:

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-10-30T03:26:33Z

Sfernan2: /* Project Description */

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'''Example Image Of Tree Display
'''
[[File:expertiza.PNG]]

=Refactoring TreeDisplayController Tasks=
==combined all of the goto methods==

==use routing helpers==

==only use 1 instance variable in list method==

==look at the rest of the methods==

=Summary and Conclusions=
=Future Work=

CSC/ECE 517 Fall 2014/oss E1463 vpd

2014-10-30T03:26:11Z

Sfernan2:

= '''E1463: Refactoring TreeDisplayController''' =

__TOC__

=Project Links=
[http://ec2-54-186-80-176.us-west-2.compute.amazonaws.com:3000/ Our Expertiza Fork on AWS]<br>
[https://github.com/Druotic/expertiza Github Repo]

=Project Description=

For this project, our team refactored the TreeDisplayController class in the [http://expertiza.ncsu.edu/ Expertiza] OSS project. This class provides access to questionnaires, review rubrics, author feedback, courses, assignments, and course evaluations. The tree display lists all of these categories with the ability for the user to "drill down" into the subcategories or just expand/collapse as needed.

'Example Image Of Tree Display'
[[File:expertiza.PNG]]

=Refactoring TreeDisplayController Tasks=
==combined all of the goto methods==

==use routing helpers==

==only use 1 instance variable in list method==

==look at the rest of the methods==

=Summary and Conclusions=
=Future Work=

File:Expertiza.PNG

2014-10-30T03:24:41Z

Sfernan2: uploaded a new version of "File:Expertiza.PNG"

expertiza

File:Expertiza.PNG

2014-10-30T03:21:07Z

Sfernan2: expertiza

expertiza

File:Exp.PNG

2014-10-30T03:15:23Z

Sfernan2: