CSC/ECE 517 Spring 2015/oss E1504 IMV
E1504. Refactoring the Bookmark Model
This page provides a description of the Expertiza based OSS project. This team project successfully refactored the Bookmark Model by removing the duplicate code, combining the methods, improving the search function, moving Bmapping model methods to their respective class, covering dependencies associated with changed segments and adding a User Interface for using bookmarks.
Introduction to Expertiza
Expertiza is a large project developed as a combined effort of students and faculty using the Ruby on Rails framework. The main advantage of using Expertiza, in an educational environment, is for the instructor to introduce peer reviewing among the students. Expertiza allows the instructor to create and customize assignments, create a list of topics the students can sign up for, have students work on teams and then review each other's assignments at the end. Expertiza supports submission of almost any document type, including the URLs and wiki pages.
Expertiza is supported by National Science Foundation under Grant No. 0536558. Additional funding from the NCSU Learning in a Technology-Rich Environment (LITRE) program, the NCSU Faculty Center for Teaching and Learning, the NCSU STEM Initiative, and the Center for Advanced Computing and Communication.
Problem Statement
Classes involved:
bookmark.rb bmapping.rb bookmarks_controller.rb auth_controller.rb auth_helper.rb
What they do: The bookmark model and controller help in creating user specific bookmarks, which can be added to topics. Also, they provide the functionality to edit these bookmarks by the created user. User can search bookmarks by either users who created them or the bookmark tags.
What needs to be done: The search methods in bookmarks model are being used used in a very granular level. This led to redundancy in bookmarks search methods. These methods include search_alltags_allusers, search_fortags_allusers, search_fortags_forusers, search_alltags_forusers. Hence duplicacies in these methods are to be singled out. As we know, in ruby, the method name should specify the pseudo use of itself. Here, add_new_bookmark misleads as this is one of the CRUB method and the naming convention is not quite right. It has to be renamed to create method. Again the case of duplicates arrive. Now in the methods add_topic_bookmark, add_this_bookmark, add_bookmark . The difference between add_topic_bookmark and add_this_bookmark is that the former takes an extra input i.e. topicid. Hence these two can be moved into one method. The third method is an unnecessary repetition of the former two methods' functionality. The method name edit_this_bookmark should be renamed to edit along with updating all the dependencies corresponding to edit_this_bookmark .Lastly, add_bmapping and add_bmapping_signuptopic have to be moved to appropriate class i.e. bmapping class. This involves checking their dependencies and updating their function calls accordingly.
Changes Made
Bookmark Model
| Method Name | Changes Made | Reason For Change |
|---|---|---|
| add_this_bookmark | Added functionality of add_topic_bookmark | To implement code reusability and remove repetitive code. |
| add_topic_bookmark | Merged the functionality into add_this_bookmarks and deleted add_topic_bookmark | To implement code reusability and remove repetitive code. |
| add_bookmark | Added a line that checks whether topic_id has been provided in the request | It allows creation of new Bmapping if no topicid was given and removes the bug of searching for bookmark with nil topicid later on. |
| search_alltags_allusers | -------------- | --------- |
| search_alltags_foruser | -------------- | --------- |
| search_fortags_allusers | -------------- | --------- |
| search_fortags_foruser | -------------- | --------- |
| add_new_bookmark | -------------- | --------- |
| edit_this_bookmark | -------------- | --------- |
| add_bmapping | -------------- | --------- |
| add_bmapping_signuptopic | -------------- | --------- |
Bookmark Controller
| Method Name | Changes Made | Reason For Change |
|---|---|---|
| create | ---------------- | ----------- |
| update | ----------------- | -------- |
| edit | -------------- | --------- |
|
destroy |
----------------- | --------- |
| --------------- | ---------- | |
| ---------- | ---------- |
Views
| Method Name | Changes Made | Reason For Change |
|---|---|---|
| bookmarks/_result.html.erb | ---------------- | ----------- |
| bookmarks/search_bookmarks.html.erb | ----------------- | -------- |
| bookmarks/view_bookmarks.html.erb | -------------- | --------- |
| bookmarks/_searchmine.html.erb | ----------------- | --------- |
| bookmarks/add_bookmark_form.html.erb | ----------------- | --------- |
| bookmarks/edit_bookmark_form.html.erb | ----------------- | --------- |
| bookmarks/managing_bookmarks.html.erb | ----------------- | --------- |
| layouts/application.html.erb | ----------------- | --------- |