Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2013/oss vna

2013-11-30T19:21:00Z

Adkalant: /* Topics Tab */

== Introduction ==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities to manage peer reviews in coursework. Expertiza is built on Ruby on Rails platform. It uses the mysql db as the backend datatbase. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. Experitza is an open source project. The source code can be forked from [https://github.com/expertiza/expertiza github] and cloned for making modifications.

Our main focus in this OSS project was on the Class: controllers/assignment_controller.rb. This controller handles interaction with an instructor who is creating or editing an assignment. Various issues in the assignments controller and the suitable code changes have been explained in the following sections.

== Project Requirements ==
1. Topics tab is non-functional, but should do what the popup menu item “Add/edit signup sheet” does. 
2. Rubrics tab should show “Teammate Review:” option if “Has Teams?” is selected and “Maximum number of members per team” is greater than 0 in General Tab. 
3. The code should retrieve timezonepref of current user in Due dates tab. Also, time/date picker asks a user to specify the hours, minutes, and seconds of a due date. 
:3.1 Use a time/date picker that doesn’t show seconds. 
:3.2 Minutes should be in the step size 5. 
:3.3 Seconds field should not be displayed 
4. Refactoring 
5. Tests for all the functionality mentioned above

== Implementation ==
This section gives brief details of all the implementations done for project E801.

----

=== Topics Tab ===
The requirement of this implementation was to make topics tab functional. This tab is mainly responsible to display a page where user can create a topic for a assignment and can see already created topics for that assignment.

====Initial Design====
Ideally, when we click on topics tab, it should display what the popup menu item “Add/edit signup sheet” does.
1.Go to Manage->Assignments
2.For a assignment, click on edit signup sheet
However, in main expertiza project, topics tab was non-functional as shown below. To check Topics tab, follow below mentioned steps: 
1.Go to Manage-> Assignments
2.Click on “edit assignment” image for any of the assignments
3.Go to “Topics” tab (You will not be able to view existing topics and create new ones)

[[File:Topics-before.png]]
====Design Considerations====
The Topics tab should ideally render "sign_up_sheet\add_signup_topcis.html.erb" partial, but to reuse this partial, Assignments would need to have several other attributes like 'sign_up_topics', 'slots_filled', 'slots_waitlisted', which are not really properties of an assignment. Hence, a new partial for adding topics "assignments/edit/add_signup_topics.html.erb" has been added. Partials for 'table_header', 'table_line', 'add_topics' from "sign_up_sheet" have been modified to be accessed from other views as well and re-used.
Also, the option to add new topics should be available only if 'Has Topics' has been checked.

====Modified Design====
In our implemented project, Topics tab shows already existing topics for an assignment and link to create a new topic where a user can create a new topic. This is similar to popup menu item “Add/edit signup sheet”.
One can follow the same steps as mentioned above to view the functionality:
1.Go to Manage-> Assignments
2.Click on “edit assignment” image for any of the assignments
3.Go to “Topics” tab (You should be able to view existing topics and create new ones)
 

[[File:has_topics.jpg]]

[[File:topics_after.png]]

If 'Has Topics' has not been checked.

[[File:not signed up.png]]

====Code Changes====
The new partial "assignments/edit/add_signup_topics.html.erb" includes checks to ensure topics can be added only if 'Has Topics' has been checked.

<% if @assignment.require_signup? %>
<%= render :partial => '/sign_up_sheet/add_topics' %>
<% end %>

The partials from sign_up_sheet controller like 'add_topics' have been modified to include controller , so that they can be accessed from other views and re-used.

<%= link_to 'New topic',:controller => 'sign_up_sheet', :action => 'new', :id => params[:id] %>

----

=== Teammate Review Rubric===
====Initial Design====
While editing or creating an assignment the Teammate Review rubric shows up irrespective of whether the assignment is a team assignment or not. It should ideally only show up if the assignment under consideration has teams.
====Modified Design====
Now, the Teammate Review rubric shows up under the Rubrics tab, only if “Has Teams?” is selected and “Maximum number of members per team” is greater than 0 in General Tab.
 
One can follow the below mentioned steps to view the functionality:
1.Go to Manage-> Assignments
2.Click on “edit assignment” image for any of the assignments
3.Click on “General” tab
4.Check “Has teams?” and give “Maximum number of members per team” greater than 0.
5.Save assignment
6.Go to “Rubrics” tab. Check if “Teammate Review:” is present.
7.Repeat the same process with “Has Teams?” unchecked and “Maximum number of members” equal to 0. This will not display “Teammate Review:” in the Rubrics tab.

====Code Changes====
Partial 'assignments/edit/rubrics.html.erb' has been modified to include the following:

if(<%= @assignment.max_team_size > 1 %> ){
addQuestionnaireTableRow(
'TeammateReviewQuestionnaire',
<%= questionnaire(@assignment, 'TeammateReviewQuestionnaire').to_json.html_safe %>.teammate_review_questionnaire,
<%= assignment_questionnaire(@assignment, 'TeammateReviewQuestionnaire').to_json.html_safe %>.assignment_questionnaire,
<%= questionnaire_options(@assignment, 'TeammateReviewQuestionnaire').to_json.html_safe %>
);
}

[[File:teams.png]]

[[File:rubric.png]]

----

=== Refactoring===
Requirements for this section were centered around the following points:
 1. Renaming set_up method. It does not indicate its functionality.
 2. Refactoring copy method
 3. Fixing spell check issue for "Maximum number of review per team"

====Initial Design====
1. set_up method is badly named. It does not indicate what functionality it implements. This method is present in assignments controller. 
2. "Maximum number of review" under rubrics tab is not spelled correctly. This can be found under :
Manage->Assignments->Edit Assignment->Rubrics
3. "copy" method in assignments controller is too long.

====Modified Design====
1. set_up has been renamed to set_up_assignment_review to better reflect what it actually implements. 
2. "Maximum number of review" has been renamed to "Maximum number of reviews". 
3. "copy" method has been refactored by moving some of its functionality into its respective method copy_assignment_questionnaire. 

----

=== Timezone Issue ===
====Initial Design====
Time zones are not handled properly in the code. The code should retrieve the Preferred Time Zone of the current user and pre-select it in the time/date picker. Also, the time/date picker asks a user to specify the hours, minutes, and seconds of a due date. Obviously we don’t care about seconds, so it would be nice to use a time/date picker that doesn’t show seconds and minutes are in steps of 5. Also daylight savings time needs to be taken care of.

[[File:Time_zone_before.png]]

====Modified Design====
The above mentioned issues are addressed and can be viewed by following the below mentioned steps:
1.Go to Profile. Set timezone to any new timezone and save it.
2.Go to Manage-> Assignments
3.Click on “Edit Assignment” image for any of the assignments
4.Go to “Due dates” tab. Click on the textfield for “Round 1: Submission”. You can find that it doesn’t show seconds and minutes are in the step size 5, also, in “Time Zone”, it shows the timezone set in the earlier step.

[[File:profile.png]]
[[File:Time_zone.png]]

====Code changes====
Following is the code change in the app/views/assignments/edit._due_dates.html.erb file :

jQuery('#datetimepicker_' + element_id).datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm z',
controlType: 'select',
timezoneList: [{value:'<%=Time.zone_offset(@user.timezonepref)%>', label: '<%=@user.timezonepref.split("\s")[0]%>'}]

The Zone_offset picks the time zone set by user in the profile tab and sets it as default

====Known Issues====
Certain timezones like Arizona are obsolete. However these are listed under available timezones as they are rendered by the form helper. When such timezones are used, the time is saved properly, but it is known to cause issues while changing timezones. In order to avoid such issues, use standard timezones. Ex: Mountain Time Zone instead of Arizona etc.

----

==Testing==

Capybara DSL was selected for running the tests in this project. Testing was concentrated around assignment controller and profile tab as the project modified code around these areas.

===Configuration===
1) First, add Capybara to your Gemfile:
group :development, :test do
gem 'rspec-rails'
gem 'capybara'
end
Run bundle install

2) In spec/spec_helper.rb, add two require calls for Capybara near the top:
ENV["RAILS_ENV"] ||= 'test'
require File.expand_path("../../config/environment", __FILE__)
require 'rspec/rails'

# Add this to load Capybara integration:
require 'capybara/rspec'
require 'capybara/rails'

3) In spec/spec_helper.rb, add
config.include Capybara::DSL

===Test database===
Prepare the test db as follows
$ rake db:prepare:test
$ rake db:migrate RAILS_ENV=test
$ rake db:test:load
$ rake db:seed RAILS_ENV=test
$ rake db:migrate RAILS_ENV=test

===Tests===
Following are the 3 main tests that were written to check the modified code.

Test1 : profile_spec.rb
Assertion : Ensure user can set default timezone

Test2 : due_date_spec.rb
Assertion : User should be able to change due dates

Test3 : topic_spec.rb
Assertion : User should be able to create sign up topics by clicking the topic tab in edit assignment page

In addition to the above tests, the following tests were added to check the sanity of the code
Creating an assignment
Login as admin
Open home page

The tests were run in ruby 1.9.3 environment sucessfully.

----

==Future work ==
In order to further refactor the assignments_controller.rb
 
:1. No usages for the following methods were found:
::- copy_participants_from_course
::- define_instructor_notification_limit

:2. Following methods can be moved to Model classes but are non-functional(throwing errors) in the existing code itself.
::-associate_assignment_with_course
::-remove_assignment_from_course

:3. Methods that add to and delete from delayed_queue should be in the delayed_queue class.(Part of different project)

:4. Due date formatting can be improvised.

----

== External Links ==
# [https://github.com/expertiza/expertiza Expertiza]
# [https://github.com/vshesha/expertiza/ E801_Expertiza]
# [http://152.46.18.166:3000/ Demo]
# [http://jqueryui.com/datepicker/ Datepicker]
# [http://trentrichardson.com/examples/timepicker/ Timepicker]
# [http://guides.rubyonrails.org/layouts_and_rendering.html Layouts and Rendering in Rails]

CSC/ECE 517 Fall 2013/oss vna

2013-11-30T19:19:54Z

Adkalant: /* Topics Tab */

CSC/ECE 517 Fall 2013/oss vna

2013-11-30T19:12:54Z

Adkalant: /* Modified Design */

== Introduction ==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities to manage peer reviews in coursework. Expertiza is built on Ruby on Rails platform. It uses the mysql db as the backend datatbase. More information on Expertiza can be found [https://github.com/expertiza/expertiza here]. Experitza is an open source project. The source code can be forked from [https://github.com/expertiza/expertiza github] and cloned for making modifications.

Our main focus in this OSS project was on the Class: controllers/assignment_controller.rb. This controller handles interaction with an instructor who is creating or editing an assignment. Various issues in the assignments controller and the suitable code changes have been explained in the following sections.

== Project Requirements ==
1. Topics tab is non-functional, but should do what the popup menu item “Add/edit signup sheet” does. 
2. Rubrics tab should show “Teammate Review:” option if “Has Teams?” is selected and “Maximum number of members per team” is greater than 0 in General Tab. 
3. The code should retrieve timezonepref of current user in Due dates tab. Also, time/date picker asks a user to specify the hours, minutes, and seconds of a due date. 
:3.1 Use a time/date picker that doesn’t show seconds. 
:3.2 Minutes should be in the step size 5. 
:3.3 Seconds field should not be displayed 
4. Refactoring 
5. Tests for all the functionality mentioned above

== Implementation ==
This section gives brief details of all the implementations done for project E801.

----

=== Topics Tab ===
The requirement of this implementation was to make topics tab functional. This tab is mainly responsible to display a page where user can create a topic for a assignment and can see already created topics for that assignment.

====Initial Design====
Ideally, when we click on topics tab, it should display what the popup menu item “Add/edit signup sheet” does.
1.Go to Manage->Assignments
2.For a assignment, click on edit signup sheet
However, in main expertiza project, topics tab was non-functional as shown below. To check Topics tab, follow below mentioned steps: 
1.Go to Manage-> Assignments
2.Click on “edit assignment” image for any of the assignments
3.Go to “Topics” tab (You will not be able to view existing topics and create new ones)

[[File:Topics-before.png]]
====Design Considerations====
The Topics tab should ideally render "sign_up_sheet\add_signup_topcis.html.erb" partial, but to reuse this partial, Assignments would need to have several other attributes like 'sign_up_topics', 'slots_filled', 'slots_waitlisted', which are not really properties of an assignment. Hence, a new partial for adding topics "assignments/edit/add_signup_topics.html.erb" has been added. Partials for 'table_header', 'table_line', 'add_topics' from "sign_up_sheet" have been modified to be accessed from other views as well and re-used.
Also, the option to add new topics should be available only if 'Has Topics' has been checked.

====Modified Design====
In our implemented project, Topics tab shows already existing topics for an assignment and link to create a new topic where a user can create a new topic. This is similar to popup menu item “Add/edit signup sheet”.
One can follow the same steps as mentioned above to view the functionality:
1.Go to Manage-> Assignments
2.Click on “edit assignment” image for any of the assignments
3.Go to “Topics” tab (You should be able to view existing topics and create new ones)
 

[[File:has_topics.jpg]]

[[File:topics_after.png]]

[[File:not signed up.png]]

----

=== Teammate Review Rubric===
====Initial Design====
While editing or creating an assignment the Teammate Review rubric shows up irrespective of whether the assignment is a team assignment or not. It should ideally only show up if the assignment under consideration has teams.
====Modified Design====
Now, the Teammate Review rubric shows up under the Rubrics tab, only if “Has Teams?” is selected and “Maximum number of members per team” is greater than 0 in General Tab.
 
One can follow the below mentioned steps to view the functionality:
1.Go to Manage-> Assignments
2.Click on “edit assignment” image for any of the assignments
3.Click on “General” tab
4.Check “Has teams?” and give “Maximum number of members per team” greater than 0.
5.Save assignment
6.Go to “Rubrics” tab. Check if “Teammate Review:” is present.
7.Repeat the same process with “Has Teams?” unchecked and “Maximum number of members” equal to 0. This will not display “Teammate Review:” in the Rubrics tab.

====Code Changes====
Partial 'assignments/edit/rubrics.html.erb' has been modified to include the following:

if(<%= @assignment.max_team_size > 1 %> ){
addQuestionnaireTableRow(
'TeammateReviewQuestionnaire',
<%= questionnaire(@assignment, 'TeammateReviewQuestionnaire').to_json.html_safe %>.teammate_review_questionnaire,
<%= assignment_questionnaire(@assignment, 'TeammateReviewQuestionnaire').to_json.html_safe %>.assignment_questionnaire,
<%= questionnaire_options(@assignment, 'TeammateReviewQuestionnaire').to_json.html_safe %>
);
}

[[File:teams.png]]

[[File:rubric.png]]

----

=== Refactoring===
Requirements for this section were centered around the following points:
 1. Renaming set_up method. It does not indicate its functionality.
 2. Refactoring copy method
 3. Fixing spell check issue for "Maximum number of review per team"

====Initial Design====
1. set_up method is badly named. It does not indicate what functionality it implements. This method is present in assignments controller. 
2. "Maximum number of review" under rubrics tab is not spelled correctly. This can be found under :
Manage->Assignments->Edit Assignment->Rubrics
3. "copy" method in assignments controller is too long.

====Modified Design====
1. set_up has been renamed to set_up_assignment_review to better reflect what it actually implements. 
2. "Maximum number of review" has been renamed to "Maximum number of reviews". 
3. "copy" method has been refactored by moving some of its functionality into its respective method copy_assignment_questionnaire. 

----

=== Timezone Issue ===
====Initial Design====
Time zones are not handled properly in the code. The code should retrieve the Preferred Time Zone of the current user and pre-select it in the time/date picker. Also, the time/date picker asks a user to specify the hours, minutes, and seconds of a due date. Obviously we don’t care about seconds, so it would be nice to use a time/date picker that doesn’t show seconds and minutes are in steps of 5. Also daylight savings time needs to be taken care of.

[[File:Time_zone_before.png]]

====Modified Design====
The above mentioned issues are addressed and can be viewed by following the below mentioned steps:
1.Go to Profile. Set timezone to any new timezone and save it.
2.Go to Manage-> Assignments
3.Click on “Edit Assignment” image for any of the assignments
4.Go to “Due dates” tab. Click on the textfield for “Round 1: Submission”. You can find that it doesn’t show seconds and minutes are in the step size 5, also, in “Time Zone”, it shows the timezone set in the earlier step.

[[File:profile.png]]
[[File:Time_zone.png]]

====Code changes====
Following is the code change in the app/views/assignments/edit._due_dates.html.erb file :

jQuery('#datetimepicker_' + element_id).datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm z',
controlType: 'select',
timezoneList: [{value:'<%=Time.zone_offset(@user.timezonepref)%>', label: '<%=@user.timezonepref.split("\s")[0]%>'}]

The Zone_offset picks the time zone set by user in the profile tab and sets it as default

====Known Issues====
Certain timezones like Arizona are obsolete. However these are listed under available timezones as they are rendered by the form helper. When such timezones are used, the time is saved properly, but it is known to cause issues while changing timezones. In order to avoid such issues, use standard timezones. Ex: Mountain Time Zone instead of Arizona etc.

----

==Testing==

Capybara DSL was selected for running the tests in this project. Testing was concentrated around assignment controller and profile tab as the project modified code around these areas.

===Configuration===
1) First, add Capybara to your Gemfile:
group :development, :test do
gem 'rspec-rails'
gem 'capybara'
end
Run bundle install

2) In spec/spec_helper.rb, add two require calls for Capybara near the top:
ENV["RAILS_ENV"] ||= 'test'
require File.expand_path("../../config/environment", __FILE__)
require 'rspec/rails'

# Add this to load Capybara integration:
require 'capybara/rspec'
require 'capybara/rails'

3) In spec/spec_helper.rb, add
config.include Capybara::DSL

===Test database===
Prepare the test db as follows
$ rake db:prepare:test
$ rake db:migrate RAILS_ENV=test
$ rake db:test:load
$ rake db:seed RAILS_ENV=test
$ rake db:migrate RAILS_ENV=test

===Tests===
Following are the 3 main tests that were written to check the modified code.

Test1 : profile_spec.rb
Assertion : Ensure user can set default timezone

Test2 : due_date_spec.rb
Assertion : User should be able to change due dates

Test3 : topic_spec.rb
Assertion : User should be able to create sign up topics by clicking the topic tab in edit assignment page

In addition to the above tests, the following tests were added to check the sanity of the code
Creating an assignment
Login as admin
Open home page

The tests were run in ruby 1.9.3 environment sucessfully.

----

==Future work ==
In order to further refactor the assignments_controller.rb
 
:1. No usages for the following methods were found:
::- copy_participants_from_course
::- define_instructor_notification_limit

:2. Following methods can be moved to Model classes but are non-functional(throwing errors) in the existing code itself.
::-associate_assignment_with_course
::-remove_assignment_from_course

:3. Methods that add to and delete from delayed_queue should be in the delayed_queue class.(Part of different project)

:4. Due date formatting can be improvised.

----

== External Links ==
# [https://github.com/expertiza/expertiza Expertiza]
# [https://github.com/vshesha/expertiza/ E801_Expertiza]
# [http://152.46.18.166:3000/ Demo]
# [http://jqueryui.com/datepicker/ Datepicker]
# [http://trentrichardson.com/examples/timepicker/ Timepicker]
# [http://guides.rubyonrails.org/layouts_and_rendering.html Layouts and Rendering in Rails]

File:Not signed.png

2013-11-30T19:12:00Z

Adkalant: Has Topics not checked.

Has Topics not checked.

CSC/ECE 517 Fall 2013/oss vna

2013-10-29T15:52:43Z

Adkalant:

== Introduction ==
== Project Requirements ==
1. Topics tab is non-functional, but should do what the popup menu item “Add/edit signup sheet” does. 
2. Rubrics tab should show “Teammate Review:” option if “Has Teams?” is selected and “Maximum number of members per team” is greater than 0 in General Tab. 
3. The code should retrieve timezonepref of current user in Due dates tab. Also, time/date picker asks a user to specify the hours, minutes, and seconds of a due date. 
:3.1 Use a time/date picker that doesn’t show seconds. 
:3.2 Minutes should be in the step size 5. 
4. Refactoring 
5. Tests for all the functionality mentioned above

== Implementation ==
This section gives brief details of all the implementations done for project E801.
=== Topics Tab ===
The requirement of this implementation was to make topics tab functional. This tab is mainly responsible to display a page where user can create a topic for a assignment and can see already created topics for that assignment.

====Initial Design====
Ideally, when we click on topics tab, it should display what the popup menu item “Add/edit signup sheet” does.
1.Go to Manage->Assignments
2.For a assignment, click on edit signup sheet
However, in main expertiza project, topics tab was non-functional as shown below. To check Topics tab, follow below mentioned steps: 
1.Go to Manage-> Assignments
2.Click on “edit assignment” image for any of the assignments
3.Go to “Topics” tab (You will not be able to view existing topics and create new ones)

[[File:Topics-before.png]]

====Modified Design====
In our implemented project, Topics tab shows already existing topics for an assignment and link to create a new topic where a user can create a new topic. This is similar to popup menu item “Add/edit signup sheet”.
One can follow the same steps as mentioned above to view the functionality:
1.Go to Manage-> Assignments
2.Click on “edit assignment” image for any of the assignments
3.Go to “Topics” tab (You should be able to view existing topics and create new ones)
 
[[File:topics-after.png]]

=== Teammate Review Rubric===
====Initial Design====
While editing or creating an assignment the Teammate Review rubric shows up irrespective of whether the assignment is a team assignment or not. It should ideally only show up if the assignment under consideration has teams.
====Modified Design====
Now, the Teammate Review rubric shows up under the Rubrics tab, only if “Has Teams?” is selected and “Maximum number of members per team” is greater than 0 in General Tab.
 
One can follow the below mentioned steps to view the functionality:
1.Go to Manage-> Assignments
2.Click on “edit assignment” image for any of the assignments
3.Click on “General” tab
4.Check “Has teams?” and give “Maximum number of members per team” greater than 0.
5.Save assignment
6.Go to “Rubrics” tab. Check if “Teammate Review:” is present.
7.Repeat the same process with “Has Teams?” unchecked and “Maximum number of members” equal to 0. This will not display “Teammate Review:” in the Rubrics tab.

[[File:teams.png]]

[[File:rubric.png]]

=== Refactoring===
Requirements for this section were centered around the following points:
 1. Renaming set_up method. It does not indicate its functionality.
 2. Refactoring copy method
 3. Fixing spell check issue for "Maximum number of review per team"

====Initial Design====
1. set_up method is badly named. It does not indicate what functionality it implements. This method is present in assignments controller. 
2. "Maximum number of review" under rubrics tab is not spelled correctly. This can be found under :
Manage->Assignments->Edit Assignment->Rubrics
3. "copy" method in assignments controller is too long.

====Modified Design====
1. set_up has been renamed to set_up_assignment_review to better reflect what it actually implements. 
2. "Maximum number of review" has been renamed to "Maximum number of reviews". 
3. "copy" method has been refactored by moving some of its functionality into its respective method copy_assignment_questionnaire. 

=== Timezone Issue ===
====Initial Design====
Time zones are not handled properly in the code. The code should retrieve the Preferred Time Zone of the current user and pre-select it in the time/date picker. Also, the time/date picker asks a user to specify the hours, minutes, and seconds of a due date. Obviously we don’t care about seconds, so it would be nice to use a time/date picker that doesn’t show seconds and minutes are in steps of 5. Also daylight savings time needs to be taken care of.

[[File:Time_zone_before.png]]

====Modified Design====
The above mentioned issues are addressed and can be viewed by following the below mentioned steps:
1.Go to Profile. Set timezone to any new timezone and save it.
2.Go to Manage-> Assignments
3.Click on “Edit Assignment” image for any of the assignments
4.Go to “Due dates” tab. Click on the textfield for “Round 1: Submission”. You can find that it doesn’t show seconds and minutes are in the step size 5, also, in “Time Zone”, it shows the timezone set in the earlier step.

[[File:profile.png]]
[[File:Time_zone.png]]

==Testing==
==Future work ==
In order to further refactor the assignments_controller.rb
 
:1. No usages for the following methods were found:
::- copy_participants_from_course
::- define_instructor_notification_limit

:2. Following methods can be moved to Model classes but are non-functional(throwing errors) in the existing code itself.
::-associate_assignment_with_course
::-remove_assignment_from_course

:3. Methods that add to and delete from delayed_queue should be in the delayed_queue class.(Part of different project)

== External Links ==
# [https://github.com/expertiza/expertiza Expertiza]
# [https://github.com/vshesha/expertiza/ E801_Expertiza]
# [http://152.46.18.166:3000/ Demo]
# [http://jqueryui.com/datepicker/ Datepicker]
# [http://trentrichardson.com/examples/timepicker/ Timepicker]
# [http://guides.rubyonrails.org/layouts_and_rendering.html Layouts and Rendering in Rails]

CSC/ECE 517 Fall 2013/oss vna

2013-10-29T14:26:20Z

Adkalant: /* Modified Design */

== Introduction ==
== Project Requirements ==
== Implementation ==
=== Topics Tab ===
====Initial Design====
[[File:Topics-before.png]]

====Design Considerations====
====Modified Design====
[[File:topics-after.png]]

=== Teammate Review Rubric===
====Initial Design====
[[File:teams.png]]

====Design Considerations====
====Modified Design====
[[File:rubric.png]]

=== Refactoring===
====Initial Design====
====Design Considerations====
====Modified Design====
=== Timezone Issue ===
====Initial Design====
[[File:profile.png]]

====Design Considerations====

====Modified Design====
[[time_zone.png]]

==Testing==
==Future work ==
== External Links ==

2013-10-29T14:19:59Z

Adkalant:

File:Topics-after.png

2013-10-29T14:18:58Z

Adkalant: Topics tab functional

Topics tab functional

CSC/ECE 517 Fall 2013

2013-10-28T22:43:24Z

Adkalant:

* [[ CSC/ECE 517 Fall 2012/ch1 1w23 ph ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w30 nn]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w21 w]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w01 aj]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w24 nv]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w29 rkld]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w25 aras]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w30 ps]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w19 rj]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w18 bs]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w17 pk]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w22 ss]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w12 vn]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w14 st]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w08 cc]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w10 ga ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w26 as ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w27 ma ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w13 aa ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w11 sv ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w07 d ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w20 gq ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w03 ss ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w28 nm ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w02 pp ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w6 zs ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w04 y ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w05 st ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w09 hs ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w32 av ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w48 x ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w43 av]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w46 ka]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w33 aa]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w35 sa ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w39 as ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w31 vm ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w43 sm ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w44 s ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w47 ka ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w34 fs ]]
* [[ CSC/ECE 517 Fall 2013/ch1 1w40 ao ]]
* [[ CSC/ECE 517 Fall 2013/oss fmv ]]
* [[ CSC/ECE 517 Fall 2013/oss vna ]]

CSC/ECE 517 Fall 2013/ch1 1w35 sa

2013-10-15T03:06:33Z

Adkalant:

[[File:207.jpg|right]]

== Introduction to Testing ==
A project lifecycle has two major components i.e. Development Cycle and Testing Cycle. Any software engineering project life cycle is not complete till the testing phase is complete. It is used for making your work robust and dependable. A lot of sensitive and important information is hosted on a website, it caters to end users, and a part of the deal is that it should work flawlessly and in its entirety.

== Approaches to Testing ==
Testing could be manual or automated. Manual Testing is described as a developer acting as an end user and testing almost all the features of the application and check if they are behaving correctly in order they are supposed to. The manual testing involves writing Test Cases and then running those test cases. Usually the Test cases are generated on the lines of the software’s functional flow.

=== Manual Testing ===
Manual Testing includes the testing of software manually i.e. without using any automated tool or any script. In manual testing the tester has to take the role of the end user and test the whole application/ software to discover any abnormality in the functioning of the code or any unexpected behaviour for that matter. This is then classified as a bug, which depending on the protocol being followed is either returned immediately to the developer to fix or is documented into a bug report which is when assigned to developers to fix. Manual Testing has different stages like [http://en.wikipedia.org/wiki/Unit_testing Unit],[http://en.wikipedia.org/wiki/Integration_testing Integration], [http://en.wikipedia.org/wiki/System_testing System] and [http://en.wikipedia.org/wiki/Acceptance_testing User Acceptance Testing].
After the reported bug are fixed, the tester will again go through the original set of test cases to test every functionality again, and if it passes this time the defects are classified as fixed and are closed. So basically the main goal for Manual Testing is that verify each part of the code to see if it’s working as it’s supposed to be and hence deliver good quality and robust code to your client.
But no all’s hunky dory with Manual Testing because repetitive manual testing can be painstaking and very challenging if you have a very large dataset. Though one way to move ahead of this problem is that you will employ black-box testing technique which will use boundary value analysis or equivalence partitioning so that this large dataset can be tested by managing it into smaller and achievable [http://en.wikipedia.org/wiki/Test_suite test suites].

==== Manual Testing for Small Projects ====
Manual Testing is more successful and less rigorous when the project is small and it can be manually tested. The tester will create a Test Strategy and test the application on basis of the generic and specific test cases, checking if the functionality of the application is correctly being implemented. He can start with the UI and move ahead to other aspects of the application. He can then file or document bugs found in the application which will be resolved and then re-tested, till the results are satisfactory.

==== Manual Testing for Large Projects ====
Manual Testing for Large Test cases often requires a group or community of developers trying to test the application for loop holes and un-expected outputs that harm the website or prevent it from being useful to its end users. A high level Test Plan has to be setup to even undertake Manual Testing on these large projects. It is a rigorous approach where the tester will have to predict and document the detailed outcomes of certain actions that the user will take when they are accessing the website. These results are then documented and the application/website goes into the Bug Fixing mode.

=== Automated Testing ===
Manual Testing though is a very good mechanism to make your website/application robust, it might not be the most efficient choice when you have a huge project and has many branches and functionalities to rigorously test specially if make modifications to small components which might affect the final outcome. Every Change Request in your code might trigger a pulse which will produce undesirable and unexpected results and if not caught in time, could result in crashing of your application. Automated tests give you the liberty to run tests on multiple platforms without any need for human interference. It can run anytime for as long period of times and in any order, whereas that’s not the case for Manual Testing as the tester has to be there to execute the test cases.
Not to be mistaken, test automation involves a significant human involvement. After creating a test plan, the developer will study the functionalities and write test cases that test those functionalities. But his role ends here; implementing those test cases is the work of the tool being used for Automated Testing.

== Pros and Cons of Manual Testing ==

'''PROS'''

* It is used in both big and small projects.
* Manual testing is better in terms of reliability.
* If the test cases have to be run on a smaller scale in a project, it’s always better to use Manual Testing.
* If the tester has to perform Ad-Hoc testing, then Manual Testing is a better fit.
* Manual Testing exposes more real time bugs, as the tester sits on a machine and tries to penetrate the system thus exposing many bugs.

'''CONS'''

* In big projects manual testing may not be every efficient and cost effective
* In big projects it’s very difficult to run manual tests on every component within a stipulated deadline and cost budget.
* Manual Testing has to be repeated for every change that was made and hence can be very tiring also exposing to unreliable testing.

== Pros and Cons of Automated Testing ==

'''PROS'''

* Extensive testing requires large number of tests to be run every time a change is made, and here the Automated Testing can be really efficient and reliable.
* Automated tests can provide “Compatibility Tests”, when you run your application on various platforms.
* Many tests scripts can be run simultaneously, and since all of them are accurate, they cut short the costs and time consumption on a large scale.
* Automated tests are relatively cheaper investment in the long run.

'''CONS'''

* Initial Investments on Automated Testing are bigger than the effort for Manual Testing.
* Sometime GUI Testing will miss out on small components like visibility of elements, placements of fields and text areas.
* Also not everything can be automated; sometimes Manual Testing is the only and the best way to go.

== Comparison of Manual and Automated Testing ==

* Automated Testing can be costly in terms of monetary benefits, but it does eliminate the costs of actual effort on testing. Manual Testing can be very laborious for huge/gigantic projects that have endless room for error.

* Automated Testing involves human labour for writing Test Cases, and sometimes if the tools used for automated testing are very complex or the structure of the Project is so nested that running Test Cases will be more laborious than a community of Testers, it might be a bad idea to choose Automated Testing over Manual.

* Testing Tools are not always “Simple” , i.e. sometimes the results produced by running Automation on a project might be difficult to comprehend, whereas Manual Testing would be very effective as the Developer/Tester knows what’s expected and can better analyze hands on if the code is not working properly, than to find it in hidden in bunch of scrambled digits.

* Though Automation seems like “Extra Work”, it really is designed to make your work easier, imagine a huge application which caters to millions of customers, where the functionality keeps on upgrading and changing. Considering if this application requires 10^3 test cases, how tardy will it be to run these number of tests manually every time a small change is done in the code. Automated Testing is a blessing in disguise, as the effort for writing test cases will be the same, but we can save a fortune of money and effort by making the Tool run the tests fortnight and see the logs early in the morning.

* Automated Testing eliminates Human and Technical Risks, many times a block of code will change drastically overtime and when the tester runs the same test cases manually, he may choose to eliminate some test cases assuming that they might not be impacted. Also sometimes during manual testing it becomes inevitable that some test cases will be left out either by choice or by natural circumstances, resulting in block of code prone to loop holes and crash issues. Which is not the case with automated Testing, as the automation tool is going to run every single test case that it was designed to test, “n” number of times repeatedly if required, and give out exact results to be read and debugged later in the project cycle.

* Certain types of Testing, such as Performance, Regression testing is well suited for Automation tool testing, while Usability Testing is much better if Manual Testing is employed.

== Few Tools for Automation of Testing ==

* Autotest
=== AutoTest ===
AutoTest is known for instant feedback on your code i.e. the test runs on its own and you don’t have to worry about it. It is used in scenarios where you need instant result on any change requests that the developer has made or the cases where you change a small functionality and you need to see if that is working fine or has had a bad impact on your working Application. Also AutoTest doesn’t require the user to switch perspectives to each time code and check its results. It’s all automated. AutoTest is for Individual Testing i.e. suppose a developer is working on a module and he decides to change functionality and then wants to test it before he can commit and integrate the piece of code to the final build. In these scenarios AutoTest is very useful.

The catchy feature of AutoTest is that, it only runs the tests that it thinks are required for the changes you made in your application.
You need to install a Ruby gem for working with AutoTest.

==== Installation of AutoTest on OS X and Linux ====
* Step 1. Install Gem [http://zentest.rubyforge.org/ZenTest/ ZenTest ]
sudo gem install ZenTest
* Step 2: If Rails development has to be done then
sudo gem install autotest-rails
* Step 3: Run AutoTest
$ cd <base directory of your rails project>
* Step 4: AutoTest will run all the test cases for the first time
* Step 5: Make some changes in your code
* Step 6: Run Auto Test Again, and you will see that the only section of your tests will run this time.

AutoTest will assume that you are using [http://test-unit.rubyforge.org/ Test::Unit] for writing your test cases. So if you’re using [https://relishapp.com/rspec/rspec-rails/docs RSpec], you need to manually inform AutoTest about your preference.

On command line type
RSPEC= true autotest

Also as an alternative to AutoTest setting true for RSpec you can also use the “autospec” command which is used instead of autotest.

On command line type
Autospec

==== Installation of AutoTest on Windows ====

* Step 1: Install gem ZenTest from the command line
gem install ZenTest
* Step 2: on the command line read the directory of your rails project
cd <path of rails project>
* Step 3: Set the Environment variable before running AutoTest
set HOME = C:\Documents and Settings\<your name on the machine>
* Step 4: In the same directory of the rails app type
autotest --rails

=== CruiseControl.rb ===

[http://cruisecontrolrb.thoughtworks.com/ CruiseControl.rb] is used for Continuous Integration. Continuous Integration means that the developers integrate their code very frequently i.e. at least on a daily basis. So using CruiseControl.rb here prevents any integration issues that might accumulate and trouble later on at the time of integration.

==== Installation of CruiseControl.rb ====
* Step 1: Download CruiseControl.rb

On Command Line type

* Step 2:
cruise add <name> -u <url>
* Step 3:
cruise start

For issues with installation , look at the [http://cruisecontrolrb.thoughtworks.com/documentation manual]

== Conclusion ==

The decision to automate testing of an application or not has to be taken purely in the context of that application. There cannot be a general set of rules which specifies that manual testing is better or automated testing is better. Following are few questions that can lead us to conclusive answers.

* Time and Effort required for Automation
The effort involved in writing a Test script should not be unreasonably more, as this might lead to more time and effort in developing test scripts than actually implementing the test cases manually. So a large part of this decision lies with how user friendly and customizable the Automation tool is.

* Expected Test Coverage
The amount of code to be tested is another criterion, if the code to be tested is fairly short, then use manual Testing, but if large code coverage is required then Automated tests will save a lot of time.

* Frequency of Testing
A lot depends on how often a piece of code is tested, if it's a critical application and requires constant effort on testing then it's better to use automated as it's less prone to make mistakes, fairly accurate and saves a huge amount of time, which could be utilized elsewhere. But if the functionality is tested only a few times then it's better to test it manually than write scripts for automation.

* Stage of Project
It’s often found that in the initial development stage of a project, it is manual testing that precedes automation to identify bugs. However for mature products, it is automation that primary and manual testing only as and when required.

Thus we need to consider time, resources, and the size of the project as well as the quality of the automated tools while deciding the combination of manual and automated testing to develop the best software possible.

== See Also ==

# [http://www.internetjournals.net/journals/tir/2009/January/Paper%2006.pdf Software Testing Methods and Techniques]
# [http://context-driven-testing.com/ Context Driven Testing]
# [http://en.wikipedia.org/wiki/Software_testing_controversies Software Testing Controversies]

== References ==

# http://en.wikipedia.org/wiki/Test_automation
# http://en.wikipedia.org/wiki/Manual_testing
# http://www.jobsnewstoday.com/2013/04/discuss-about-adverse-between-manual-testing-vs-automation-testing.html
# http://www.developsense.com/blog/2013/02/manual-and-automated-testing/
# http://www.softwaretestingmentor.com/automation/manual-vs-automation/
# http://blog.typemock.com/2012/04/05/the-difference-between-automated-and-manual-testing
# http://apprenda.com/blog/manual-v-automated-testing-achieving-consistency/
# http://www.base36.com/2013/03/automated-vs-manual-testing-the-pros-and-cons-of-each/
# http://www.tutorialspoint.com/software_testing/testing_types.htm
# http://www.slideshare.net/Softwarecentral/manual-testing-vs-automated-testing
# http://selleo.com/blog/software-outsourcing/the-value-of-automated-testing/2/