Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T17:25:20Z

Qjia2: /* course_team.rb */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T17:20:04Z

Qjia2: /* Concerns for Test Cases */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T17:19:27Z

Qjia2: /* Concerns for Test Cases */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T17:10:08Z

Qjia2: /* Possible Refactoring */

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-29T17:09:09Z

Qjia2: /* Possible Bugs */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st previous E1406 project]. For the previous project, we did some refactoring and testing for the controllers related to teams. This time, we are going to reuse most of our test environment, but extend the tests to other team-related classes. We also expect to examine and report the code that may require refactoring.

== Test Environment ==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

=== Statistics ===
''Please note that the coverage generate by SimpleCov may be lower than expect due to the added fixtures.''

; Overall (set of 6 tests) : 105 tests, 156 assertions, 2 failures, 3060 / 13457 LOC (22.74%) covered.
; Unit tests : 18 tests, 18 assertions, 0 failures
; Functional tests : 87 tests, 138 assertions, 2 failures (reasons of failures can be found in "Possible Bugs")

== Running Tests ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
Run
rake test:prepare
before each action.
To run unit tests
bundle exec ruby -I.:test -e "ARGV.each{|f| require f}" test/unit/team_test.rb test/unit/course_team_test.rb test/unit/assignment_team_test.rb test/unit/team_user_test.rb
To run functional tests
bundle exec ruby -I.:test -e "ARGV.each{|f| require f}" test/functional/advertise_for_partner_controller_test.rb test/functional/teams_users_controller_test.rb
You can also run multiple tests
bundle exec ruby -I.:test -e "ARGV.each{|f| require f}" test/functional/teams_users_controller_test.rb test/functional/advertise_for_partner_controller_test.rb test/unit/course_team_test.rb test/unit/assignment_team_test.rb test/unit/team_test.rb test/unit/team_user_test.rb

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.
=== advertise_for_partner.rb ===
* This controller takes over the advertisement function from the student_team_controller, and make the class more RESTful.
* It seems like there has been a functional test, but the class name and set up looks like the other class. It may be necessary to re-run, and even re-write the test
=== team.rb ===
* This model defines the relationship between team object and other objects. It also has other methods to handle related functions about team operation
* There exists a unit test for team model, but there are only two test cases. Also, some of the methods under team.rb are duplicated, or either marked as not working. Further research may be required before starting to do the test.
=== assignment_team.rb & course_team.rb ===
* Both assignment_team class and course_team class are inherited from team class.
* These two classes have similar methods, which could be used to manage teams for assignment and course more effectively.
== Summary of Found Issues ==
=== Changes made to the class===
==== team.rb ====
''Based on the discussion from the demo, the duplicated method was deleted instead of commented out''
* duplicated def get_participants was removed
** This is removed because the same method is defined again at line 20
* duplicated def self.generate_team_name() was removed
** This is removed because the same method is defined again at line 131
==== advertise_for_team_controller.rb ====
* def new was removed
** since it's empty, there is no need to keep the code there

=== Possible Refactoring ===
==== team.rb ====
* line 81 def self.create_node_object(name, parent_id)
** see the TODO at line 80, the method will not work.
=== advertise_for_team_controller.rb ===
* ''update'' should be ''edit'' (this is mentioned in the comments of code)
* ''edit'' should be reexamined since it is only assigning the team object
=== assignment_team.rb ===
* in "delete" method, before sign_up.each.destory, we need to make sure sign_up is not nil.
* in "email" method, a method named get_team_users is called but this method has no definition. We should define get_team_users somewhere or delete "email" method.
=== course_team.rb ===
* add_participant(course_id, user)method should belong to course rather than course_team. Delete this method.
* self.export_all_assignment_team_related_to_course(csv, parent_id, options)method should be deleted.

=== Possible Bugs ===
==== team.rb ====
* def add_member(user, assignment_id) allow nil to be passed
** rails always raise runtime error when nil is passed. [[#unit/team_test.rb|Test: "add member for course should create teams user" ]]
* def randomize_all_by_parent passing wrong arguments
** The code is passing wrong arguments in line 124 for add_member, there should be 2 arguments. [[#unit/team_test.rb|Test: "randomize_all_by_parent" ]]
* def import_team_members passing wrong arguments
** it is calling add_member and passing nil for assignment_id, which will make rails raise error.[[#unit/team_test.rb|Test: "import team members successfully" ]]
==== assignment_team.rb ====
* def self.get_export_fields(options)
** when the option team_name => false, the second element of the output array should be "Team members". But from the test, it is "Assignment Name". This is one failure from assignment_team_test.rb
* def add_participant(assignment_id, user)
** the AssignmentParticipant.count does not increase. This is another failure from assignment_team_test.rb.
==== teams_user.rb ====
* def delete(option)
** should not call ''team.delete'', it will cause recursion error
* def self.is_team_empty(team_id)
** rewrite this method without using ''length'' method, the ''length'' method will generate errors here
==== teams_users_controller.rb ====
* def delete_selected(options)
** the statement ''TeamsUser.find(item_id).first'' cannot work, since the method ''find'' will return an exact object, which cannot be applied ''first'' method

== Setup ==

To set up our testing for the models and controllers, we need some fixtures to support.
Fixtures needed for corresponding classes are listed below
'''However, all of the fixtures are required to be in the fixutre folder, otherwise it will raise error.'''

=== fixtures use in common ===
* teams.yml
* users.yml
* teams_users.yml
* courses.yml
* assignments.yml
* teams_participant.yml
* join_team_requests.yml
* participants.yml
* nodes.yml
* questions.yml
* signed_up_users.yml

== Use Case Diagram ==

=== advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Concerns for Test Cases ==

=== functional/teams_users_controller_test.rb ===
[[File:TeamUsersStory.png]]

Based on the user story of the teams_users_controller.rb, there are also several sub-scenarios for each method in the user story.

* Auto_complete_for_user_name:
** Test auto_complete_for_user_name with valid user name
** Test auto_complete_for_user_name with invalid user name

* List
** Test List with valid team id
** Test List with invalid team id

* New
** Test New with valid team id
** Test New with invalid team id

* Create
** Test Create with valid team id
*** Test Create with valid user id and maximum member number is not reached
*** Test Create with invalid user id and maximum member number is not reached
*** Test Create with valid user id and maximum member number is reached
*** Test Create with invalid user id and maximum member number is reached
** Test Create with invalid team id
*** Test Create with valid user id and maximum member number is not reached
*** Test Create with invalid user id and maximum member number is not reached
*** Test Create with valid user id and maximum member number is reached
*** Test Create with invalid user id and maximum member number is reached

* Delete
** Test Delete with valid user id
** Test Delete with invalid user id

* Delete_select
** Test Delete_select with valid item id
** Test Delete_select with invalid item id

=== unit/teams_users_test.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== functional/advertise_for_partner_controller_test.rb ===
* # test "test update advertisement fail" do
** should show flash for fail message when team.save fail, but there is no really a good way to fail team.save, so this is not implemented

=== unit/team_test.rb ===
Most of test should be straightforward, so only the test with concerns will be listed below
* test "get_participants from assignment team" do
** Please notice that this will actually call the get_participants under AssignmentTeam

* test "generate_team_name" do
** Please notice that this method (self.generate_team_name)is modified

* test "add member for course should create teams user" do
** In the original code, it allow nil to be passed as parameter, and checks for assignment_id = nil, but rails will actually raise runtime error when nil is passed.

* #test "randomize_all_by_parent" do
** Commented out because the bug in the code make it raise error because assignment id not passed. (wrong argument)

* #test "import team members successfully" do
** problem: add_member are not passing correct assignment id in team.rb

=== unit/assignment_team_test.rb ===
Because most of the tests are straightforward, only tests with concerns are listed.
* delete
** this method has bug. In the method, before sign_up.each.destory, we need to make sure sign_up is not nil. No test
* email
** this method has bug because there is no method named get_team_users. No test

=== unit/course_team_test.rb ===
Only tests with concerns are listed.
*add_participant(course_id, user)
** this method should belong to course rather than course_team. This test may be not useful.
* self.export_all_assignment_team_related_to_course(csv, parent_id, options)
** this method should be deleted from course_team class. No test

== Possible Refactoring ==
=== teams_participant.rb & teams_participants_controller.rb ===
* These two files are never used, no tests will cover them.

=== teams_user.rb ===
* In ''delete'' method, the statements about ''team.delete'' should be commented out due to the recursion it causes.
* ''elf.is_team_empty'' method is rewritten since the original code will cause fatal error.

=== teams_users_controller.rb ===
* ''delete_select'' method will not work since the params are not in accordance with the method called inside.

==Sample Test Code==
We show two pieces of test code for two controllers from our previous work to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/final doc updated qyx

2014-04-25T00:11:32Z

Qjia2: /* Possible Refacotring */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st previous E1406 project]. For the previous project, we did some refactoring and testing for the controllers related to teams. This time, we are going to reuse most of our test environment, but extend the tests to other team-related classes. We also expect to examine and report the code that may require refactoring.
== Test Environment ==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.
=== advertise_for_partner.rb ===
* This controller takes over the advertisement function from the student_team_controller, and make the class more RESTful.
* It seems like there has been a functional test, but the class name and set up looks like the other class. It may be necessary to re-run, and even re-write the test
=== team.rb ===
* This model defines the relationship between team object and other objects. It also has other methods to handle related functions about team operation
* There exists a unit test for team model, but there are only two test cases. Also, some of the methods under team.rb are duplicated, or either marked as not working. Further research may be required before starting to do the test.
=== assignment_team.rb & course_team.rb ===
* Both assignment_team class and course_team class are inherited from team class.
* These two classes have similar methods, which could be used to manage teams for assignment and course more effectively.
== Changes made to original classes ==
=== team.rb ===
* line 10 def get_participants removed
** This is commented out because the same method is defined again at line 26
* line 38 def self.generate_team_name() removed
** This is commented out because the same method is defined again at line 150
* line 100 def self.create_node_object(name, parent_id)
** see the TODO at line 99, the method will not work.

== Test Classes ==
=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

=== app/controllers/advertise_for_partners_controller.rb ===
The advertise_for_partners_controller work with the student_team_controllers, allowing student manage advertisement for their teams.

A student can:
* create a new advertisement for the team
* edit the advertisement content
* remove advertisement record from the table for the specific team

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

* get_participants : get participant in the team
* delete : delete a team member in the team
* get_node_type : will return “TeamNode”
* get_author_name : will return team’s name
* generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
* get_possible_team_members(name) : find a team member by name
* has_user(user : find a team member by user object
* add_member(user, assignment_id) : add a user to an assignment team
* copy_members(new_team) : copy current member in the team to the new team
* create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
* check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
* delete_all_by_parent(parent) : delete all teams under the same course/assignment
* randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
* generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
* import_team_members(starting_index, row) : import user from specific index of users and length

=== app/unit/assignment_team.rb ===
* includes?(participant): check if this assignment team include this participant
* assign_reviewer(reviewer): assign a reviewer for this assignment team
* reviewed_by?(reviewer)：check if this assignment team is reviewed by this reviewer
* topic: get the topic picked up by this team
* has_submissions?: check if this team submitted work or not
* reviewed_contributor?(contributor)
* participants: get all the participants
* delete: delete the signed up users
* self.get_first_member(team_id): get the first participant
* get_hyperlinks
* get_path
* get_submitted_files
* get_review_map_type: return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* email： get fist team user's email
* get_participant_type: return AssignmentParticipant
* get_parent_model：return Assignment
* fullname
* get_participants
* copy(course_id): copy a team from course team
* add_participant(assignment_id, user): add participant to AssignmentParticipant
* assignment
* get_scores(questions): return a hash of scores that the team has received for the questions
* self.get_team(participant): get this participant's team
* self.export(csv, parent_id, options): export assignment and team members
* self.get_export_fields(options)
* self.create_team_and_node(assignment_id)
* self.remove_team_by_id(id): Remove a team given the team id

=== app/unit/course_team.rb ===
* get_participant_type: return CourseParticipant
* get_parent_model：return Course
* get_node_type: return TeamNode
* assignment_id: return nil
* copy(assignment_id): copy a team from assignment team
* add_participant(course_id, user): add a user to a course. Note: this is deprecated because the functionality belongs to course
* export_participants: export the participants of a course team
* export(team_name_only): export team name, participants and course
* self.handle_duplicate(team, name, assignment_id, handle_duplicates): handle duplicate team in different cases
* self.import(row,session,assignment_id,options): import team members to a exist team or a new team
* self.export(csv, parent_id, options): export course and team members
* self.get_export_fields(options)
* self.export_all_assignment_team_related_to_course(csv, parent_id, options): this method is deprecated
* self.create_team_and_node(assignment_id)

== Setup ==

To set up our testing for the models and controllers, we need some fixtures to support.
Fixtures needed for corresponding classes are listed below
'''However, all of the fixtures are required to be in the fixutre folder, otherwise it will raise error.'''

=== fixtures use in common ===
* teams.yml
* users.yml
* teams_users.yml
* courses.yml
* assignments.yml
* teams_participant.yml
* join_team_requests.yml
* participants.yml
* nodes.yml
* questions.yml
* signed_up_users.yml

== Use Case Diagram ==

=== advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== functional/teams_users_controller_test.rb ===
[[File:TeamUsersStory.png]]

Based on the user story of the teams_users_controller.rb, there are also several sub-scenarios for each method in the user story.

* Auto_complete_for_user_name:
** Test auto_complete_for_user_name with valid user name
** Test auto_complete_for_user_name with invalid user name

* List
** Test List with valid team id
** Test List with invalid team id

* New
** Test New with valid team id
** Test New with invalid team id

* Create
** Test Create with valid team id
*** Test Create with valid user id and maximum member number is not reached
*** Test Create with invalid user id and maximum member number is not reached
*** Test Create with valid user id and maximum member number is reached
*** Test Create with invalid user id and maximum member number is reached
** Test Create with invalid team id
*** Test Create with valid user id and maximum member number is not reached
*** Test Create with invalid user id and maximum member number is not reached
*** Test Create with valid user id and maximum member number is reached
*** Test Create with invalid user id and maximum member number is reached

* Delete
** Test Delete with valid user id
** Test Delete with invalid user id

* Delete_select
** Test Delete_select with valid item id
** Test Delete_select with invalid item id

=== unit/teams_users_test.rb ===

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== functional/advertise_for_partner_controller_test.rb ===
* test "test remove advertisement should set advertise_for_partner false" do
* test "test remove advertisement should remove advertisement comments" do
* test "test remove advertisement should redirect to view" do
* test "test create advertisement should set advertise_for_partner true" do
* test "test create advertisement should set comment for advertisement" do
* test "test create advertisement should redirect to view" do
* test "test update advertisement successfully should show notice" do
* test "test update advertisement successfully should change comment" do
* test "test update advertisement successfully should redirect to view" do
* # test "test update advertisement fail" do
** should show flash for fail message when team.save fail, but there is no really a good way to fail team.save, so this is not implemented
* test "test edit advertisement" do
** only assign team

=== unit/team_test.rb ===
* test "add_team" do
* test "delete should destroy the team" do
* test "delete should remove all teams user" do
* test "delete should remove all team node" do
* test "get_participants from assignment team" do
** Please notice that this will actually call the get_participants under AssignmentTeam
* test "get_participants from course team" do
* test "get_node_type" do
* test "get_author_name" do
* test "generate_team_name" do
** Please notice that this method (self.generate_team_name)is modified
* test "generate_team_name for existed prefix" do
* test "get_possible_team_members" do
* test "has_user" do
* test "do not has_user" do
* test "add member already in team" do
* test "add member for course should create teams user" do
** In the original code, it allow nil to be passed as parameter, and checks for assignment.id = nil, but rails will actually raise runtime error when nil is passed.
* test "add member for course should create teams user node" do
* test "add member to assignment team successfully" do
* test "add member to full assignment team should fail" do
* test "copy_members from assignment team" do
* test "copy_members from course team" do
* test "check_for_existing for AssignmentTeam" do
* test "check_for_existing for existed AssignmentTeam should raise error" do
* test "delete all by parent should delete teams" do
* test "delete all by parent will not fail when no teams found" do
* #test "randomize_all_by_parent" do
** Commented out because the bug in the code make it raise error because assignment id not passed. (wrong argument)
* test "import team members for user not existed should raise error" do
* #test "import team members successfully" do
** problem: add_member are not passing correct assignment id at line 169 in team.rb

=== unit/assignment_team_test.rb ===
* includes?(participant)
** test one assignment team include a participant return true
* assign_reviewer(reviewer)
** assign a reviewer for this assignment team, and TeamReviewResponseMap.count increases
* reviewed_by?(reviewer)
** TeamReviewResponseMap is empty, so test this method will return false
* has_submissions?
** test one team has a submission return true
* reviewed_contributor?(contributor)
** TeamReviewResponseMap is empty, so test this method will return false
* participants
** participants are not nil
* delete
** this method has bug. No test
* self.get_first_member(team_id)
** test first menber not nil
* get_hyperlinks
** test hyperlinks are not nil
* get_path
** test path is not nil
* get_submitted_files
** submitted_file must be empty, expect nil
* get_review_map_type
** return TeamReviewResponseMap
* self.handle_duplicate(team, name, assignment_id, handle_duplicates)
** test in different cases(team is nil, option is "ignore", option is "rename")
* self.import(row,session,assignment_id,options)
** test in different cases(argument error, has_column_name is true, has_column_name is false)
* email
** this method has bug because there is no method named get_team_users. No test
* get_participant_type
** return AssignmentParticipant
* get_parent_model
** return Assignment
* fullname
** return value should equal what we expect
* get_participants
** test the participants are not nil
* copy(course_id)
** TeamUserNode.count and TeamsUser.count increase
* add_participant(assignment_id, user)
** AssignmentParticipant.count increases
* assignment
** return value should equal what we expect
* get_scores(questions)
** return output's total score is not nil and the assignment team is what we expect
* self.get_team(participant)
** return team is what we expect
* self.export(csv, parent_id, options)
** test in different cases(team_name is true, team_name is false)
* self.get_export_fields(options)
** test if the fields' name is right
* self.create_team_and_node(assignment_id)
** assignent team and team node are not nil
* self.remove_team_by_id(id)
** check the removed team cannot be found in AssignmentTeam

=== unit/course_team_test.rb ===
Because most of the methods in course_team.rb are similar with that in assignment_team.rb if they have the same name. So I skip the same name method. Take the test/unit/course_team_test.rb as a reference.
* self.export_all_assignment_team_related_to_course(csv, parent_id, options)
** this method should be deleted here. No test

== Possible Refacotring ==
=== advertise_for_team_controller.rb ===
* ''update'' should be ''edit'' (this is mentioned in the comments of code)
* ''edit'' should be reexamined since it is only retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

=== teams_participant.rb & teams_participants_controller.rb ===
* These two files are never used, no tests will cover them.

=== teams_user.rb ===
* In ''delete'' method, the statements about ''team.delete'' should be commented out due to the recursion it causes.
* ''elf.is_team_empty'' method is rewritten since the original code will cause fatal error.

=== teams_users_controller.rb ===
* ''delete_select'' method will not work since the params are not in accordance with the method called inside.

== Running Tests ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

You can also run multiple tests
rake test:prepare
bundle exec ruby -I.:test -e "ARGV.each{|f| require f}" test/functional/teams_users_controller_test.rb test/functional/advertise_for_partner_controller_test.rb test/unit/course_team_test.rb test/unit/assignment_team_test.rb test/unit/team_test.rb test/unit/team_user_test.rb

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Sample Test Code==
We show two pieces of test code for two controllers from our previous work to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T23:35:56Z

Qjia2: /* teams_users.rb & teams_users_controller.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
== Introduction ==
This project will be an extension of our [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2014/oss_E1406_st previous E1406 project]. For the previous project, we did some refactoring and testing for the controllers related to teams. This time, we are going to reuse most of our test environment, but extend the tests to other team-related classes. We also expect to examine and report the code that may require refactoring.
== Test Environment ==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.
=== teams_participant.rb & teams_participant_controller.rb===
* teams_participant.rb and teams_participant_controller.rb are used to manage the participants of teams.
* There is no functional test for teams_participant_controller.rb and unit test for teams_participant.rb in the current version of expertiza codes.
=== advertise_for_partner.rb ===
* This controller takes over the advertisement function from the student_team_controller, and make the class more RESTful.
* It seems like there has been a functional test, but the class name and set up looks like the other class. It may be necessary to re-run, and even re-write the test
=== team.rb ===
* This model defines the relationship between team object and other objects. It also has other methods to handle related functions about team operation
* There exists a unit test for team model, but there are only two test cases. Also, some of the methods under team.rb are duplicated, or either marked as not working. Further research may be required before starting to do the test.

==Classes==
=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

=== app/controllers/advertise_for_partners_controller.rb ===
The advertise_for_partners_controller work with the student_team_controllers, allowing student manage advertisement for their teams.

A student can:
* create a new advertisement for the team
* edit the advertisement content
* remove advertisement record from the table for the specific team

=== app/models/teams_participant.rb===
The teams_participant.rb is a model belonging to both users and teams. It is used when a team participant is created, listed or deleted.

=== app/controllers/teams_participant_controller.rb===
The teams_participant_controller support team participants management so the team participant:
* get a participant name by inputting part of the name
* list team participants of a team
* add a participant to a team
* remove a selected team participant from a team
* remove all team participants belonging to an item

=== app/models/team.rb ===
The “team” object represents a team that consists students who are either participants of course or assignment.
a team will response to the request on:

;get_participants : get participant in the team
;delete : delete a team member in the team
;get_node_type : will return “TeamNode”
;get_author_name : will return team’s name
;generate_team_name() : serialize the automatically generated team name (e.g. team 1, team 2, etc.)
;get_possible_team_members(name) : find a team member by name
;has_user(user : find a team member by user object
;add_member(user, assignment_id) : add a user to an assignment team
;copy_members(new_team) : copy current member in the team to the new team
;create_node_object(name, parent_id) : ‘’there is a TODO on this method indicated that this is not working’’
;check_for_exisiting(parent, name, team_type) : check if the team name under the same assignment or course is in use.
;Delete_all_by_parent(parent) : delete all teams under the same course/assignment
;Randomize_all_by_parent(parent, team_type, team_size) : randomly assign team members
;generate_team_name(teamnameprefix) : generate team name with prefix (e.g. prefix_Team1)
;import_team_members(starting_index, row) : import user from specific index of users and length

== Setup ==

To set up our testing for the models and controllers, we need some fixtures to support.
Fixtures needed for corresponding classes are listed below

=== fixtures use in common ===
* teams.yml
* users.yml
* teams_users.yml
* courses.yml
* assignments.yml

=== teams_participant.rb & teams_participant_controller.rb ===
Besides the above fixtures, we also need the following fixrure
* teams_participant.yml

=== teams.rb ===
* teams_participant.yml
* join_team_requests.yml
* participants.yml
* nodes.yml

== Use Case Diagram ==

=== teams_participant_controller.rb ===
[[File:Usercase.jpg]]

=== advertise_for_partner_controller.rb ===
[[File:Usecase_E1414_advertise.jpg]]

== Testing Scenarios ==

=== teams_users.rb & teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

Based on the user story of the teams_users_controller.rb, there are also several sub-scenarios for each method in the user story.

* Auto_complete_for_user_name:
** Test auto_complete_for_user_name with valid user name
** Test auto_complete_for_user_name with invalid user name

* List
** Test List with valid team id
** Test List with invalid team id

* New
** Test New with valid team id
** Test New with invalid team id

* Create
** Test Create with valid team id
*** Test Create with valid user id and maximum member number is not reached
*** Test Create with invalid user id and maximum member number is not reached
*** Test Create with valid user id and maximum member number is reached
*** Test Create with invalid user id and maximum member number is reached
** Test Create with invalid team id
*** Test Create with valid user id and maximum member number is not reached
*** Test Create with invalid user id and maximum member number is not reached
*** Test Create with valid user id and maximum member number is reached
*** Test Create with invalid user id and maximum member number is reached

* Delete
** Test Delete with valid user id
** Test Delete with invalid user id

* Delete_select
** Test Delete_select with valid item id
** Test Delete_select with invalid item id

For the methods in teams_user.rb, the scenarios would be like the following:

* Delete
** Test Delete to check if it could delete the team node and the team user

* Remove_team
** Test Remove_team with valid user_id and valid team_id
** Test Remove_team with valid user_id and invalid team_id
** Test Remove_team with invalid user_id and valid team_id
** Test Remove_team with invalid user_id and invalid team_id

* Is_team_empty
** Test Is_team_empty with empty team
** Test Is_team_empty with non-empty team

* Add_member_to_invited_team
** Test Add_member_to_invited_team with valid user_id and valid team_id
** Test Add_member_to_invited_team with valid user_id and invalid team_id
** Test Add_member_to_invited_team with invalid user_id and valid team_id
** Test Add_member_to_invited_team with invalid user_id and invalid team_id

=== teams_participant.rb & teams_participant_controller.rb ===

* Auto_complete_for_user_name:
** Test auto_complete_for_user_name with valid user name
** Test auto_complete_for_user_name with invalid user name

* List
** Test List with valid team id
** Test List with invalid team id

* New
** Test New with valid team id
** Test New with invalid team id

* Create
** Test Create with valid team id
*** Test Create with valid user id and maximum member number is not reached
*** Test Create with invalid user id and maximum member number is not reached
*** Test Create with valid user id and maximum member number is reached
*** Test Create with invalid user id and maximum member number is reached
** Test Create with invalid team id
*** Test Create with valid user id and maximum member number is not reached
*** Test Create with invalid user id and maximum member number is not reached
*** Test Create with valid user id and maximum member number is reached
*** Test Create with invalid user id and maximum member number is reached

* Delete
** Test Delete with valid user id
** Test Delete with invalid user id

* Delete_select
** Test Delete_select with valid item id
** Test Delete_select with invalid item id

=== advertise_for_partner_controller.rb ===
* remove
** test remove with valid user id
** test remove with invalid user id

* create
** test create with valid user id
** test create with invalid user id

* update
** test update with invalid id
** test update success
** test update fail (should remain the same)

* edit
** test edit
=== team.rb ===
* get participants
** test get participants

* delete
** test delete with team node
** test delete without team node

* get_node_type
** test get node type

* get_author_name
** test author name

* generate_team_name()
** test generate team name from zero
** test generate team name from one

* get_possible_team_members(name)
** test get possible team members by exact name
** test get possible team members by similar name
** test get possible team members by name in other team

* has_user(user)
** test has user with valid user
** test has user with invalid user

* add_member(user, assignment_id)
** test add member with valid user
** test add member already in team
** test add member without assignment id
** test add member when max team size reached

* copy_members(new_team)
** test copy members to empty new team
** test copy members to nonempty new team
** test copy members with no member in current team

* create_node_object(name, parent_id)
** ‘’there is a TODO on this method indicated that this is not working’’

* check_for_exisiting(parent, name, team_type)
** test check for exisiting with exisited name
** test check for exisiting with nonexisted name

* delete_all_by_parent(parent)
** test delete with valid parents
** test delete with invalid parents

* randomize_all_by_parent(parent, team_type, team_size)
** test randomize all by parent with exact number
** test randomize all by parent without enough people
** test randomize all by parent with remainder

* generate_team_name(teamnameprefix)
** test generate prefix team name with valid name
** test generate prefix team name with duplicated name

* import_team_members(starting_index, row)
** test import team members with valid index and row
** test import team members with invalid index and row

== Possible Refacotring ==
=== advertise_for_team_controller.rb ===
* ''update'' should be ''edit'' (this is mentioned in the comments of code)
* ''edit'' should be reexamined since it is only retrieving the team object
* ''new'' is empty, so it should be removed

=== team.rb ===
* There are two ''def get_participants'', the second one overwritten the first one, so the first one should be deleted.

== Running Tests ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/unit/<filename> # for models
and
rake test TEST=test/functional/<filename> # for controllers

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Sample Test Code==
We show two pieces of test code for two controllers from our previous work to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:59:25Z

Qjia2: /* app/models/teams_users.rb & app/controllers/teams_users_controller.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

== Setup ==

To set up our testing for the models and controllers, we need some fixtures to support.
Fixtures needed for corresponding classes are listed below

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
* Teams.yml
* Usres.yml
* Teams_Uers.yml
* Courses.yml
* Assignments.yml

== Testing Scenarios ==

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

Based on the user story of the teams_users_controller.rb, there are also several sub-scenarios for each method in the user story.

* Auto_complete_for_user_name:
** Test auto_complete_for_user_name with valid user name
** Test auto_complete_for_user_name with invalid user name

* List
** Test List with valid team id
** Test List with invalid team id

* New
** Test New with valid team id
** Test New with invalid team id

* Create
** Test Create with valid team id
*** Test Create with valid user id and maximum member number is not reached
*** Test Create with invalid user id and maximum member number is not reached
*** Test Create with valid user id and maximum member number is reached
*** Test Create with invalid user id and maximum member number is reached
** Test Create with invalid team id
*** Test Create with valid user id and maximum member number is not reached
*** Test Create with invalid user id and maximum member number is not reached
*** Test Create with valid user id and maximum member number is reached
*** Test Create with invalid user id and maximum member number is reached

* Delete
** Test Delete with valid user id
** Test Delete with invalid user id

* Delete_select
** Test Delete_select with valid item id
** Test Delete_select with invalid item id

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:57:13Z

Qjia2: /* app/models/teams_users.rb & app/controllers/teams_users_controller.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

== Setup ==

To set up our testing for the models and controllers, we need some fixtures to support.
Fixtures needed for corresponding classes are listed below

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
* Teams.yml
* Usres.yml
* Teams_Uers.yml
* Courses.yml
* Assignments.yml

== Testing Scenarios ==

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

Based on the user story of the teams_users_controller.rb, there are also several sub-scenarios for each method in the user story.

*Auto_complete_for_user_name:
**Test auto_complete_for_user_name with valid user name
**Test auto_complete_for_user_name with invalid user name

List
1. Test List with valid team id
2. Test List with invalid team id
New
1. Test New with valid team id
2. Test New with invalid team id

Create
1. Test Create with valid team id
a) Test Create with valid user id and maximum member number is not reached
b) Test Create with invalid user id and maximum member number is not reached
c) Test Create with valid user id and maximum member number is reached
d) Test Create with invalid user id and maximum member number is reached
2. Test Create with invalid team id
a) Test Create with valid user id and maximum member number is not reached
b) Test Create with invalid user id and maximum member number is not reached
c) Test Create with valid user id and maximum member number is reached
d) Test Create with invalid user id and maximum member number is reached

Delete
1. Test Delete with valid user id
2. Test Delete with invalid user id

Delete_select
1. Test Delete_select with valid item id
2. Test Delete_select with invalid item id

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:56:02Z

Qjia2: /* app/models/teams_users.rb & app/controllers/teams_users_controller.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

== Setup ==

To set up our testing for the models and controllers, we need some fixtures to support.
Fixtures needed for corresponding classes are listed below

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
* Teams.yml
* Usres.yml
* Teams_Uers.yml
* Courses.yml
* Assignments.yml

== Testing Scenarios ==

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
[[File:TeamUsersStory.png]]

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:55:40Z

Qjia2: /* app/models/teams_users.rb & app/controllers/teams_users_controller.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

== Setup ==

To set up our testing for the models and controllers, we need some fixtures to support.
Fixtures needed for corresponding classes are listed below

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
* Teams.yml
* Usres.yml
* Teams_Uers.yml
* Courses.yml
* Assignments.yml

== Testing Scenarios ==

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
[[File:TeamUserStory.png]]

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:55:10Z

Qjia2: /* app/models/teams_users.rb & app/controllers/teams_users_controller.rb */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

== Setup ==

To set up our testing for the models and controllers, we need some fixtures to support.
Fixtures needed for corresponding classes are listed below

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
* Teams.yml
* Usres.yml
* Teams_Uers.yml
* Courses.yml
* Assignments.yml

== Testing Scenarios ==

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
[[File:teamsUserStory.png]]

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

File:TeamUsersStory.png

2014-04-09T18:54:31Z

Qjia2: user story

user story

File:QQ截图20140409144837.png

2014-04-09T18:52:35Z

Qjia2: Blanked the page

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:50:03Z

Qjia2: /* Tasks */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

== Setup ==

To set up our testing for the models and controllers, we need some fixtures to support.
Fixtures needed for corresponding classes are listed below

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
* Teams.yml
* Usres.yml
* Teams_Uers.yml
* Courses.yml
* Assignments.yml

== Testing Scenarios ==

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

File:QQ截图20140409144837.png

2014-04-09T18:49:17Z

Qjia2: user story

user story

File:QQ截图20140409144358.png

2014-04-09T18:46:31Z

Qjia2: user story

user story

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:37:02Z

Qjia2: /* app/models/teams_users.rb & app/controllers/teams_users_controller.rb = */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

== Setup ==

To set up our testing for the models and controllers, we need some fixtures to support.
Fixtures needed for corresponding classes are listed below

=== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
* Teams.yml
* Usres.yml
* Teams_Uers.yml
* Courses.yml
* Assignments.yml

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:36:44Z

Qjia2: /* Setup */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

== Setup ==

To set up our testing for the models and controllers, we need some fixtures to support.
Fixtures needed for corresponding classes are listed below

== app/models/teams_users.rb & app/controllers/teams_users_controller.rb ===
* Teams.yml
* Usres.yml
* Teams_Uers.yml
* Courses.yml
* Assignments.yml

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:33:17Z

Qjia2: /* E1414: Testing classes related to teams */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

== Setup ==

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:32:20Z

Qjia2: /* Classes */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/models/teams_users.rb===
The teams_users.rb is a model belonging to both users and teams. It is used when a user is added to a team.

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:29:22Z

Qjia2: /* Motivation */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Background ==

=== teams_users.rb & teams_users_controller.rb===
* Teams_users.rb and teams_users_controller.rb are used for Instructor/TA to manage the members of teams.
* There is no functional test for teams_users_controller.rb and unit test for teams_users.rb in the current version of expertiza codes.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1414 st

2014-04-09T18:25:42Z

Qjia2: /* Classes */

=E1414: Testing classes related to teams=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__
==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team

=== app/controllers/teams_users_controller.rb===
The teams_users_controller support team member management for instructor/TA accounts
Instruction/TA can:
* get a user name by inputting part of the name
* list team members of a team
* add a user to a team
* remove a team member from a team
* remove all members belonging to an item

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
* write tests

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : [http://guides.rubyonrails.org/testing.html Rails default test framework]
;Sample data : Fixtures (under /test/fixtures)
;Coverage tool: [https://rubygems.org/gems/simplecov SimpleCov]
;Total Number of Tests : 37
;Previous Coverage : 22.32%
;Current Coverage : 24.08%

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
* View student team (GET #view)
* Edit team (GET #edit)
* Create team with valid name (POST #create)
* Create team with name in use (POST #create)
* Update valid team name (POST #update)
* Update team name in use (POST #update)
* Update with current team name (POST #update)
* Advertise (GET #advertise)
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

* Remove advertisement (GET #remove_advertisement )
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
* Leave student team (GET #leave)
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
* Create team should increase the number of teams by 1(GET #create)
* Create team should increase the number of team nodes by 1(GET #create)
* Create team with existing name (POST #create)
* Create team should redirect to list assignments (POST #create)
* Delete all teams (GET #delete_all)
* Delete all teams should redirect to list (GET #delete_all)
* List should receive assignment (GET #list)
* List should receive course (GET #list)
* New should assign parent (GET #new)
* Update team should redirect (POST #update)
* Update team should have validate name (POST #update)
* Edit team should have time (POST #edit)
* Delete team should redirect (POST #delete)
* Delete team should decrease the number of teams by 1(GET #delete)
* Delete team should decrease the number of team nodes by 1(GET #delete)
* Inherit team should redirect (POST #inherit)
* Bequeath team should redirect (POST #bequeath)
The methods in the following are ignored in testing since they are never used in current codes.
* create_teams_view
* create_teams

==Sample Test Code==
We show two pieces of test code for two controllers to explain how our test works

test "create_student team with name in use" do
sessionVars = session_for(users(:student8))
post(:create, {'team' => { 'name' => 'IntelligentTeam2'}, 'id' => participants(:par21).id, "commit" => "Create Team"}, sessionVars, nil)
assert_equal 'Team name is already in use.', flash[:notice]
assert_redirected_to :controller => 'student_team', :action => 'view', :id => participants(:par21).id
end

test "create_should_increase_number_of_teams_course" do
sessionVars = session_for(users(:instructor1))
sessionVars[:team_type] = "Course"
assert_difference 'Team.count' do
get :create, {'id' => @testCourse,'team' => {'name' => "Random"}},sessionVars
end
end

The first piece of code is from student_team_controller.rb. It tests if there is already a same team name when student8 want to create a team. The second piece of code is from teams_controller_test.rb. It tests if the team number decreases when instructor1 creates a new team for a course.

As we can see from the code, when we want to use <code>post</code> or <code>get</code>, several parameters are needed. Usually we use four parameters: First, the method we are requesting. Second, an hash of request parameters for the method. Third, an optional hash of session variables. Forth, an optional hash of flash values. If we do not want to pass in the optional hash, we can set it to nil as the first piece of code shows, or we can just leave it blank as the second piece of code shows.

When we run the command <code>rake test TEST=test/functional/your_test_file.rb</code>, you will see if the test is passed or not.

==Result==

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

There are several error raised from ''leave'' method need to be fixed, as mentioned above. Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.
===teams_controller===
The method <code>create_teams_view</code> does not be used at all. So it is safe to delete it.

The method <code>create_teams</code> calls the method <code>randomize_all_by_parent</code>, which is not correct. The developer may want to fix these bugs.

It's possible that we can write more testing cases if we improve the fixture.

==References==
<references/>
* http://guides.rubyonrails.org/testing.html
* https://github.com/colszowka/simplecov

CSC/ECE 517 Spring 2014/oss E1406 st

2014-03-31T20:25:07Z

Qjia2: /* teams_controller */

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__

==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team
* <del>review members</del> (removed)

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
*write tests

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : Rails default test framework<ref>http://guides.rubyonrails.org/testing.html</ref>
;Sample data : Fixtures (under /test/fixtures)
;Total Number of Tests : ??

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
===== View student team (GET #view) =====
===== Edit team (GET #edit) =====
===== Create team with valid name (POST #create) =====
===== Create team with name in use (POST #create) =====
===== Update valid team name (POST #update) =====
===== Update team name in use (POST #update) =====
===== Update with current team name (POST #update) =====
===== Advertise (GET #advertise) =====
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

===== Remove advertisement (GET #remove_advertisement ) =====
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
===== Leave student team (GET #leave) =====
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following.
=====Create team with valid name=====
=====Create team with existing name=====
=====Delete all teams=====
=====Delete specified team=====
=====Update team with valid name=====
=====Update team with existing name=====
=====List available teams=====
=====Inherit team from course to assignment=====
=====Create/Delete/Update/Inherit should redirect=====
The methods in the following are ignored in testing since they are never used in current codes.
=====create_teams_view=====
=====create_teams=====

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

<del>There are several error raised from ''leave'' method need to be fixed, as mentioned above.</del> Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-03-31T20:20:57Z

Qjia2: /* Tasks */

=E1406: Improve tests & investigate regex warnings for team functionality=
''Please be advised that we do not have deployment link, since our work are all back-end tests''
__TOC__

==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team
* <del>review members</del> (removed)

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage increase 2%
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
*write tests

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : Rails default test framework<ref>http://guides.rubyonrails.org/testing.html</ref>
;Sample data : Fixtures (under /test/fixtures)
;Total Number of Tests : ??

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
===== View student team (GET #view) =====
===== Edit team (GET #edit) =====
===== Create team with valid name (POST #create) =====
===== Create team with name in use (POST #create) =====
===== Update valid team name (POST #update) =====
===== Update team name in use (POST #update) =====
===== Update with current team name (POST #update) =====
===== Advertise (GET #advertise) =====
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

===== Remove advertisement (GET #remove_advertisement ) =====
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
===== Leave student team (GET #leave) =====
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following. The method create_team_view is ignored in testing since in current codes it is never used
=====Create team with valid name=====
=====Create team with existing name=====
=====Delete all teams=====
=====Delete specified team=====
=====Update team with valid name=====
=====Update team with existing name=====
=====Inherit team from course to assignment=====

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

<del>There are several error raised from ''leave'' method need to be fixed, as mentioned above.</del> Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-03-31T19:44:56Z

Qjia2: /* teams_controller */

=E1406: Improve tests & investigate regex warnings for team functionality=

__TOC__

==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team
* <del>review members</del> (removed)

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage of 22%.
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
*write tests

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : Rails default test framework<ref>http://guides.rubyonrails.org/testing.html</ref>
;Sample data : Fixtures (under /test/fixtures)
;Total Number of Tests : ??

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
===== View student team (GET #view) =====
===== Edit team (GET #edit) =====
===== Create team with valid name (POST #create) =====
===== Create team with name in use (POST #create) =====
===== Update valid team name (POST #update) =====
===== Update team name in use (POST #update) =====
===== Update with current team name (POST #update) =====
===== Advertise (GET #advertise) =====
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

===== Remove advertisement (GET #remove_advertisement ) =====
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
===== Leave student team (GET #leave) =====
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following. The method create_team_view is ignored in testing since in current codes it is never used
=====Create team with valid name=====
=====Create team with existing name=====
=====Delete all teams=====
=====Delete specified team=====
=====Update team with valid name=====
=====Update team with existing name=====
=====Inherit team from course to assignment=====

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

<del>There are several error raised from ''leave'' method need to be fixed, as mentioned above.</del> Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-03-31T19:43:01Z

Qjia2: /* teams_controller */

=E1406: Improve tests & investigate regex warnings for team functionality=

__TOC__

==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team
* <del>review members</del> (removed)

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage of 22%.
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
*write tests
*ignore create_teams_view method since it is not used

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : Rails default test framework<ref>http://guides.rubyonrails.org/testing.html</ref>
;Sample data : Fixtures (under /test/fixtures)
;Total Number of Tests : ??

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
===== View student team (GET #view) =====
===== Edit team (GET #edit) =====
===== Create team with valid name (POST #create) =====
===== Create team with name in use (POST #create) =====
===== Update valid team name (POST #update) =====
===== Update team name in use (POST #update) =====
===== Update with current team name (POST #update) =====
===== Advertise (GET #advertise) =====
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

===== Remove advertisement (GET #remove_advertisement ) =====
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
===== Leave student team (GET #leave) =====
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
Current test cases are as following. The method create_team_view is ignored in testing since in current codes it is never used
=====Create team with valid name=====
=====Create team with existing name=====
=====Delete all teams=====
=====Delete specified team=====
=====Update team with valid name=====
=====Update team with existing name=====
=====Inherit team from course to assignment=====

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

<del>There are several error raised from ''leave'' method need to be fixed, as mentioned above.</del> Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-03-31T19:42:10Z

Qjia2: /* Testing Scenarios */

=E1406: Improve tests & investigate regex warnings for team functionality=

__TOC__

==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team
* <del>review members</del> (removed)

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage of 22%.
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
*write tests
*ignore create_teams_view method since it is not used

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : Rails default test framework<ref>http://guides.rubyonrails.org/testing.html</ref>
;Sample data : Fixtures (under /test/fixtures)
;Total Number of Tests : ??

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
===== View student team (GET #view) =====
===== Edit team (GET #edit) =====
===== Create team with valid name (POST #create) =====
===== Create team with name in use (POST #create) =====
===== Update valid team name (POST #update) =====
===== Update team name in use (POST #update) =====
===== Update with current team name (POST #update) =====
===== Advertise (GET #advertise) =====
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

===== Remove advertisement (GET #remove_advertisement ) =====
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
===== Leave student team (GET #leave) =====
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

====teams_controller====
The method create_team_view is ignored in testing since in current codes it is never used
=====Create team with valid name=====
=====Create team with existing name=====
=====Delete all teams=====
=====Delete specified team=====
=====Update team with valid name=====
=====Update team with existing name=====
=====Inherit team from course to assignment=====

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

<del>There are several error raised from ''leave'' method need to be fixed, as mentioned above.</del> Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-03-31T19:33:04Z

Qjia2: /* student_team_controller */

=E1406: Improve tests & investigate regex warnings for team functionality=

__TOC__

==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team
* <del>review members</del> (removed)

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage of 22%.
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

===teams_controller===
*write tests
*ignore create_teams_view method since it is not used

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : Rails default test framework<ref>http://guides.rubyonrails.org/testing.html</ref>
;Sample data : Fixtures (under /test/fixtures)
;Total Number of Tests : ??

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
===== View student team (GET #view) =====
===== Edit team (GET #edit) =====
===== Create team with valid name (POST #create) =====
===== Create team with name in use (POST #create) =====
===== Update valid team name (POST #update) =====
===== Update team name in use (POST #update) =====
===== Update with current team name (POST #update) =====
===== Advertise (GET #advertise) =====
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

===== Remove advertisement (GET #remove_advertisement ) =====
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
===== Leave student team (GET #leave) =====
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

<del>There are several error raised from ''leave'' method need to be fixed, as mentioned above.</del> Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-03-31T19:28:41Z

Qjia2: /* app/controllers/teams_controller.rb */

=E1406: Improve tests & investigate regex warnings for team functionality=

__TOC__

==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)
* update team's information

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team
* <del>review members</del> (removed)

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage of 22%.
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : Rails default test framework<ref>http://guides.rubyonrails.org/testing.html</ref>
;Sample data : Fixtures (under /test/fixtures)
;Total Number of Tests : ??

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
===== View student team (GET #view) =====
===== Edit team (GET #edit) =====
===== Create team with valid name (POST #create) =====
===== Create team with name in use (POST #create) =====
===== Update valid team name (POST #update) =====
===== Update team name in use (POST #update) =====
===== Update with current team name (POST #update) =====
===== Advertise (GET #advertise) =====
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

===== Remove advertisement (GET #remove_advertisement ) =====
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
===== Leave student team (GET #leave) =====
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

<del>There are several error raised from ''leave'' method need to be fixed, as mentioned above.</del> Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-03-31T19:25:52Z

Qjia2: /* app/controllers/teams_controller.rb */

=E1406: Improve tests & investigate regex warnings for team functionality=

__TOC__

==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment(inherit)

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team
* <del>review members</del> (removed)

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage of 22%.
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : Rails default test framework<ref>http://guides.rubyonrails.org/testing.html</ref>
;Sample data : Fixtures (under /test/fixtures)
;Total Number of Tests : ??

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
===== View student team (GET #view) =====
===== Edit team (GET #edit) =====
===== Create team with valid name (POST #create) =====
===== Create team with name in use (POST #create) =====
===== Update valid team name (POST #update) =====
===== Update team name in use (POST #update) =====
===== Update with current team name (POST #update) =====
===== Advertise (GET #advertise) =====
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

===== Remove advertisement (GET #remove_advertisement ) =====
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
===== Leave student team (GET #leave) =====
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

<del>There are several error raised from ''leave'' method need to be fixed, as mentioned above.</del> Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/oss E1406 st

2014-03-31T19:25:23Z

Qjia2: /* app/controllers/teams_controller.rb */

=E1406: Improve tests & investigate regex warnings for team functionality=

__TOC__

==Classes==
=== app/controllers/teams_controller.rb ===

teams_controller contains functionalities for team management for instructor/TA accounts.
Instructor/TA can:
* view current teams
* create new teams
* import/export teams
* delete all teams/delete specified team
* copy existing teams from a course down to an assignment

=== app/controllers/student_team_controller.rb ===
The student_team_controller support team management for student account.
student can
* create team
* view current team (including team invitations received and sent)
* advertise for their team
* remove the advertise for their team
* leave the team
* <del>review members</del> (removed)

== Motivation ==
There were no functional tests written on the two controllers to detect bugs, as well as confirming they are functional by itself and after integration.

Our goal is to add comprehensive functional tests and integration tests to the two controllers to provide a preferable test suite for the future developers.

Also, as the classes are influenced by the changes from other, we are also responsible for fixing some of the bugs, refactoring the method names to a better ones, as well as reporting the bugs found in the testing process.

== Tasks ==
Overall: contribute to the code coverage, ideally having overall coverage of 22%.
===student_team_controller===
* write tests
* def advertise_for_partners # change to “advertise”
* def remove # change to “remove_advertisment”
* def review # remove this method

== Deployment ==
Please note that all of our work will be under the /test folder, which means they will not show any change on the view.
To see the result of tests, run
rake test TEST=test/functional/student_team_controller.rb
and
rake test TEST=test/functional/teams_controller

running the whole test suite with <code>rake test</code> is not recommended, as the schema change overtime has broke some of the previous tests.

==Testing==

;Framework : Rails default test framework<ref>http://guides.rubyonrails.org/testing.html</ref>
;Sample data : Fixtures (under /test/fixtures)
;Total Number of Tests : ??

===Testing Scenarios===
====student_team_controller====
Most of the test case are straightforward. There are some of the test cases was commented out due to bug in the controller
===== View student team (GET #view) =====
===== Edit team (GET #edit) =====
===== Create team with valid name (POST #create) =====
===== Create team with name in use (POST #create) =====
===== Update valid team name (POST #update) =====
===== Update team name in use (POST #update) =====
===== Update with current team name (POST #update) =====
===== Advertise (GET #advertise) =====
''This is currently commented out in the committed code. It seems like the method is never called. It raises missing template error upon every call. ''
The <code>advertise</code> method was previously named advertise_for_partners, but renamed due to ambiguity as there is another class with the same name.

===== Remove advertisement (GET #remove_advertisement ) =====
The <code>remove_advertisement</code> method was previously named remove, but renamed to avoid ambiguity
This method is never called as well, but it is functional as it do not require any template.
===== Leave student team (GET #leave) =====
''This is currently commented out in the committed code, because it will raise error every time when called.''
It seems like problem happens on
line 96: other_members = TeamsUser.where( ['team_id = ?', params[:team_id]]).first
line 97: if other_members.length == 0
This will raise error due to the calling length of other_members, which is a single object but not an array.
Also, the related record seems to be remain undeleted in the database.

==Future Works==
===student_team_controller===
''Please note that this bug was reported fixed in the newest version of master branch of expertiza, but the fix came too late''

<del>There are several error raised from ''leave'' method need to be fixed, as mentioned above.</del> Future teams may need to add tests on it as soon as it fixed, since it is a crucial functionality of the student team.

Also, methods that seems like not being used, such as <code>advertise</code> and <code>remove_advertisement</code> may need to be double checked and see if they are redundant.

==References==
<references/>

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-10T21:20:07Z

Qjia2:

== '''Ruby libraries to load objects of other languages at run time''' ==

This is an advanced topic. Libraries are being developed where Ruby gems can load libraries (and even native code) of other languages.A few open-source projects like FFI are currently working on this. Previous version is available [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/ch1_1w21_w here]

__TOC__
==Introduction==
===Runtime Library===
In computer programming, a runtime library is the API used by a compiler to invoke some of the behaviors of a runtime system. The runtime system implements the execution model and other fundamental behaviors of a programming language. The compiler inserts calls to the runtime library into the executable binary. During execution (run time) of that computer program, execution of those calls to the runtime library cause communication between the application and the runtime system. This often includes functions for input and output, or for memory management.
The runtime library may implement a portion of the runtime system's behavior, but if one reads the code of the calls available, they typically are thin wrappers that simply package information and send it to the runtime system. However, sometimes the term runtime library is meant to include the code of the runtime system itself, even though much of that code cannot be directly reached via a library call.

For example, some language features that can be performed only (or are more efficient or accurate) at runtime are implemented in the runtime system and may be invoked via the runtime library API, e.g. some logic errors, array bounds checking, dynamic type checking, exception handling and possibly debugging functionality. For this reason, some programming bugs are not discovered until the program is tested in a "live" environment with real data, despite sophisticated compile-time checking and pre-release testing. In this case, the end user may encounter a runtime error message.

The concept of a runtime library should not be confused with an ordinary program library like that created by an application programmer or delivered by a third party, nor with a dynamic library, meaning a program library linked at run time.

===libffi===
FFI stands for Foreign Function Interface. A foreign function interface is the popular name for the interface that allows code written in one language to call code written in another language. The libffi was originally written by Anthony Green<ref>http://moxielogic.org/blog</ref>. The libffi library really only provides the lowest, machine dependent layer of a fully featured foreign function interface. A layer must exist above libffi that handles type conversions for values passed between the two languages.<ref>http://sourceware.org/libffi/</ref>
libffi is a foreign function interface library. It provides a C programming language interface for calling natively compiled functions given information about the target function at run time instead of compile time. It also implements the opposite functionality: libffi can produce a pointer to a function that can accept and decode any combination of arguments defined at run time.
libffi is most often used as a bridging technology between compiled and interpreted language implementations. libffi may also be used to implement plug-ins, where the plug-in's function signatures are not known at the time of creating the host application.
Notable users include Python, Haskell, Dalvik, F-Script, PyPy, PyObjC, RubyCocoa, JRuby, Rubinius, MacRuby, gcj, GNU Smalltalk, IcedTea, Cycript, Pawn, Squeak, Java Native Access, Racket,<ref>http://en.wikipedia.org/wiki/Libffi#cite_note-2</ref> Embeddable Common Lisp and Mozilla.<ref>http://en.wikipedia.org/wiki/Libffi#cite_note-3</ref>
On Mac OS X libffi is commonly used with BridgeSupport, which provides programming language neutral descriptions of framework interfaces, and Nu which binds direct Objective-C access from Lisp.
libffi has been widely ported and is released under a MIT license.

===Ruby-FFI===
Ruby-FFI<ref>https://github.com/ffi/ffi/wiki</ref> is a Foreign Function Interface extension for Ruby. It is an FFI extension doesn't need compilation and can be used on multi-platform and multi-implementation. Ruby-FFI extension is easy to read,write and maintain. In addition, it is impervious to changes in the internal Ruby API.
====Overall Architecture====
Using Ruby-FFI, you can use native libraries from Ruby without writing a single line of native code. Ruby-FFI takes care of all of the cross Ruby implementation (MRI, JRuby, Rubinius, MacRuby, etc) and platform specific issues so that you can focus on writing and testing your Ruby code.

As FFI is effectively a bridge between the multiple worlds of Ruby implementations and multiple platform types, you might suffer a bit of cognitive dissonance trying to pull all the pieces together. When we develop in Ruby we tend to think in higher level terms, and don't so much concern ourselves with the lower level issues.
====Core Components====
Ruby-FFI has a number of useful components. Investing the time to understand FFI's components and capabilities will pay off as you begin using FFI. That said, it's nice to have an idea which components you should look at first. Understanding the following core modules and classes is a great way to start getting FFI's capabilities.

*'''FFI::Library'''
Along with require 'ffi', this module brings FFI's powerful native library interfacing capabilities into your Ruby code as a DSL. Typically you extend your custom module with this one, specify the native libraries and their calling conventions, prototype the native library's functions and structs in Ruby, and then start using the native library's API from Ruby.
*'''FFI::Pointer'''
Wraps native memory allocated by a third party library. It provides a number of methods for transferring data from unmanaged native memory to Ruby-managed native memory (FFI::MemoryPointer). The native memory wrapped by this class is not freed during garbage collection runs.
*'''FFI::MemoryPointer'''
Allows for Ruby code to allocate native memory and pass it to non-Ruby libraries. Lifecycle management (allocation and deallocation) are handled by this class, so when it gets garbage collected the native memory is also freed.
*'''FFI::Struct and FFI::Union'''

==How does it work?<ref>http://www.rubyinside.com/ruby-ffi-library-calling-external-libraries-now-easier-1293.html</ref>==
The many compiled bridges between external libraries and Ruby pose a problem for alternate implementations like JRuby, because of the complexity involved in exposing internals of the implementation or expensive serialization in both directions. Instead, an interface is necessary so that instead of developing libraries that act only as unique bridges to others, we can just have one library that provides the interface to any arbitrary library of our choice.

Ruby already has a library called "dl" that makes it possible to dynamically link external libraries with Ruby. It's a bit arcane though, and Charles points out that it's not widely used "because of real or perceived bugs." Given this, and given the need for an implementation that can be compatible with JRuby, Wayne Meissner has developed "FFI", a new Ruby library that provides "Foreign Function Interface" features to Ruby.
===Progress of FFI<ref>http://blog.headius.com/2008/10/ffi-for-ruby-now-available.html</ref>===
One of the largest problems plaguing Ruby implementations is the ever-painful story of "extensions". In general, these take the form of a dynamic library, usually written in C, that plugs into and calls Ruby's native API as exposed through ruby.h and libruby. Ignoring for the moment the fact that this API exposes way more of Ruby's internals than it should, extensions present a very difficult problem for other implementations:

Do we support them or not?

In many cases, this question is answered for us; most extensions require access to object internals we can't expose, or can't expose without extremely expensive copying back and forth. But there's also a silver lining: the vast majority of C-based extensions exist solely to wrap another library.

Isn't it obvious what's needed here?

This problem has been tackled by a number of libraries on a number of platforms. On the JVM, there's Java Native Access (JNA). On Python, there's ctypes. And even on Ruby, there's the "dl" stdlib, wrapping libdl for programmatic access to dynamic libraries. But dl is not widely used, because of real or perceived bugs and a rather arcane API. Something better is needed.

Wayne is one of the primary maintainers of JNA, and has recently spent time on a new higher-performance version of it called JFFI. Wayne also became a JRuby committer this spring, and perhaps his most impressive contribution to date is a full FFI library for JRuby, based on JNA (eventually JFFI, once we migrate fully) and implementing the full set of what we and Evan agreed would be "FFI API 1.0". We shipped the completed FFI support in JRuby 1.1.4.

The "Passwd" and "Group" structures for functions like 'getpwuid':
<pre>
module Etc
class Passwd < FFI::Struct
layout :pw_name, :string, 0,
:pw_passwd, :string, 4,
:pw_uid, :uint, 8,
:pw_gid, :uint, 12,
:pw_dir, :string, 20,
:pw_shell, :string, 24
end
class Group < FFI::Struct
layout :gr_name, :string, 0,
:gr_gid, :uint, 8
end
end
</pre>

In JRuby 1.1.5, we've taken another step forward with the API, adding support for callbacks. How would we represent a callback you pass into a C function from Ruby?

Binding and calling "qsort" with an array of integers:
<pre>
require 'ffi'

module LibC
extend FFI::Library
callback :qsort_cmp, [ :pointer, :pointer ], :int
attach_function :qsort, [ :pointer, :int, :int, :qsort_cmp ], :int
end

p = MemoryPointer.new(:int, 2)
p.put_array_of_int32(0, [ 2, 1 ])
puts "Before qsort #{p.get_array_of_int32(0, 2).join(', ')}"
LibC.qsort(p, 2, 4) do |p1, p2|
i1 = p1.get_int32(0)
i2 = p2.get_int32(0)
i1 < i2 ? -1 : i1 > i2 ? 1 : 0
end
puts "After qsort #{p.get_array_of_int32(0, 2).join(', ')}"
</pre>

What good is having such a library if it doesn't run everywhere? Up until recently, only Rubinius and JRuby supported FFI, which made our case for cross-implementation use pretty weak. Even though we were getting good use out of FFI, there was no motivation for anyone to use it in general, since the standard Ruby implementation had no support.

That is, until Wayne pulled another rabbit out of his hat and implemented FFI for C Ruby as well. The JRuby team is proud to announce a wholly non-JRuby library: FFI is now available on Ruby 1.9 and Ruby 1.8.6/7, in addition to JRuby 1.1.4+ and Rubinius (though Rubinius does not yet support callbacks).

Session showing installation and use of FFI in C Ruby:
<pre>
$ sudo gem install ffi
Password:
Building native extensions. This could take a while...
Successfully installed ffi-0.1.1
1 gem installed
Installing ri documentation for ffi-0.1.1...
Installing RDoc documentation for ffi-0.1.1...
[headius @ cnutter:~]
$ irb
>> require 'ffi'
=> true
>> module RubyFFI
>> extend FFI::Library
>> attach_function :getuid, [], :uint
>> end
=> #<FFI::Invoker:0x1fe8c>
>> puts RubyFFI.getuid
501
=> nil
>>
</pre>

Our hope with JRuby's support of FFI and our release of FFI for C Ruby is that we may finally escape the hell of C extensions.

A key feature that's not well documented is the use of FFI's templating system to generate bindings based on the current platform's header files. Here's a sample from the "Etc" module above.

Etc module template, showing how to pull in header files and inspect a struct definition:

<pre>
module Etc
class Passwd < FFI::Struct
@@@
struct do |s|
s.include "sys/types.h"
s.include "pwd.h"

s.name "struct passwd"
s.field :pw_name, :string
s.field :pw_passwd, :string
s.field :pw_uid, :uint
s.field :pw_gid, :uint
s.field :pw_dir, :string
s.field :pw_shell, :string
end
@@@
end
class Group < FFI::Struct
@@@
struct do |s|
s.include "sys/types.h"
s.include "grp.h"

s.name "struct group"
s.field :gr_name, :string
s.field :gr_gid, :uint
end
@@@
end
end
</pre>

===Basic Usage of Ruby-FFI<ref>https://github.com/ffi/ffi/wiki/Basic-Usage</ref>===
Before showing the example, we would introduce several FFI's core components<ref>https://github.com/ffi/ffi/wiki/Core-Concepts#wiki-figure-1---overall-ffi-architecture</ref>. Understanding the following core modules and classes is a great way to start getting FFI's capabilities:

*FFI::Library - along with require 'ffi', this module provides FFI library interfacing capabilities into your Ruby code. Typically you need to extend your custom module with FFI::Library, specify the native libraries and their calling conventions, prototype the native library's functions and structs in Ruby, and then start using the native library's API from Ruby.
*FFI::Pointer - wraps native memory allocated by a third party library. It provides a number of methods for transferring data from unmanaged native memory to Ruby-managed native memory (FFI::MemoryPointer). The native memory wrapped by this class is not freed during garbage collection runs.
*FFI::MemoryPointer - allows for Ruby code to allocate native memory and pass it to non-Ruby libraries. Lifecycle management (allocation and deallocation) are handled by this class, so when it gets garbage collected the native memory is also freed.
*FFI::Struct and FFI::Union

Here is a "Hello, World" example how to use Ruby-FFI.

<pre>
require 'ffi'

module Hello
extend FFI::Library
ffi_lib FFI::Library::LIBC
attach_function :puts, [ :string ], :int
end

Hello.puts("Hello, World")
</pre>

The interesting part above is the attach_function call. It requests that a C function named puts which takes a :string argument and returns an :int, be attached to the Hello module.

The attach_function method locates the C function in a specific external library (i.e. libc in the example). The name of the function, the parameter types and the return type are needed. In the above example, attach_function locates a function named puts, which papameter type and return type are :string and :int respectively.

The typical parameter and return types<ref>https://github.com/ffi/ffi/wiki/Types</ref> are listed here:

* :char and :uchar - 8 bit signed and unsigned values
* :short and :ushort - 16 bit signed and unsigned values
* :int and :uint - 32 bit signed and unsigned values
* :long_long and :ulong_long - 64 bit signed and unsigned values
* :long and :ulong - native cpu word (32 bit or 64bit) signed and unsigned values. Equivalent to C 'long' type.
* :float and :double
* :string - C string, NULL terminated.
* :pointer - a C pointer

You can also pass the struct as parameter. For example:

<pre>
typedef struct _WHAT {
int d;
} WHAT;

int doit(WHAT w) {
printf("%d\n", w.d);
return w.d;
}
</pre>

<pre>
class WHAT < FFI::Struct
layout :d, :int
end
attach_function 'doit', [ WHAT.by_value ], :int
</pre>

In the above 2 pieces of code, attach_function uses struct WHAT as a parameter type.

===Docs on FFI===
[http://wiki.jruby.org/wiki/Calling_C_from_JRuby Calling C from JRuby] 
[http://blog.segment7.net/articles/2008/01/15/rubinius-foreign-function-interfaceRubinius's Foreign Function Interface] 
[http://pluskid.lifegoo.com/?p=370On the Rubinius FFI] 

==Who uses it?==
The libffi library is useful to anyone trying to build a bridge between interpreted and natively compiled code. Some notable users include:
*CPython - the default, most-widely used implementation of the Python programming language uses libffi in the standard ctypes library.
*OpenJDK - the open-source implementation of the Java Platform Standard Edition uses libffi to bridge between the interpreter and native code for some platforms.
*js-ctypes - a foreign function interface for javascript that Mozilla will be shipping in Firefox 3.6.
*Dalvik - Dalvik is the virtual machine which runs the Java platform on Android mobile devices. libffi is used on Android ports for which no custom bridging code has been written.
*Java Native Access (JNA) - the JNI-free way to call native code from Java.
*Ruby-FFI - a Foreign Function Interface extension for Ruby.
*fsbv - Foreign Structure By Value is a foreign function interface library for Common Lisp that extends the standard CFFI package to include support for passing structure arguments by value.
*JSCocoa - call Objective-C code from javascript on Mac OSX and the iPhone (via the libffi-iphone port).
*PyObjC - call Objective-C code from Python on Mac OSX.
*RubyCocoa - call Objective-C code from Ruby on Mac OSX.
*PLT Scheme - call C code from this popular Scheme implementation (also used as the implementation platform for Paul Graham's new Lisp, Arc).
*gcj - the runtime library for the GNU Compiler for the Java Programming Language uses libffi to handle calls back and forth between interpreted and natively compiled code. gcj is part of the GCC, the GNU Compiler Collection.

==Supported Platforms==
Libffi has been ported to many different platforms. For specific configuration details and testing status, please refer to the wiki page [http://www.moxielogic.org/wiki/index.php?title=Libffi_3.0.13 here]

==Adoption==
[http://ruby-doc.org/stdlib-2.0/libdoc/fiddle/rdoc/index.html Fiddle] 
A libffi wrapper in the Ruby Standard Library 
[http://github.com/ffi/ffi Ruby-FFI] 
A Foreign Function Interface extension for Ruby. 
[http://en.wikipedia.org/wiki/RubyCocoa RubyCocoa] 
Call Objective-C code from Ruby on Mac OSX. 

==See Also==
http://en.wikipedia.org/wiki/Libffi

=='''References''' ==
<references/>
*http://github.com/atgreen/libffi/blob/master/LICENSE
*http://repository.readscheme.org/ftp/papers/sw2004/barzilay.pdf
*http://hg.mozilla.org/mozilla-central/file/2dc00d4b379a/js/ctypes/libffi
*https://developer.mozilla.org/en/js-ctypes
*https://developer.mozilla.org/en/js-ctypes/js-ctypes_reference
*http://blog.headius.com/2008/10/ffi-for-ruby-now-available.html
*http://www.rubyinside.com/ruby-ffi-library-calling-external-libraries-now-easier-1293.html
*http://sourceware.org/libffi/

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-10T21:19:41Z

Qjia2:

== '''Ruby libraries to load objects of other languages at run time''' ==

This is an advanced topic. Libraries are being developed where Ruby gems can load libraries (and even native code) of other languages.A few open-source projects like FFI are currently working on this. Previous version is available [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/ch1_1w21_w here]

__TOC__
==Introduction==
===Runtime Library===
In computer programming, a runtime library is the API used by a compiler to invoke some of the behaviors of a runtime system. The runtime system implements the execution model and other fundamental behaviors of a programming language. The compiler inserts calls to the runtime library into the executable binary. During execution (run time) of that computer program, execution of those calls to the runtime library cause communication between the application and the runtime system. This often includes functions for input and output, or for memory management.
The runtime library may implement a portion of the runtime system's behavior, but if one reads the code of the calls available, they typically are thin wrappers that simply package information and send it to the runtime system. However, sometimes the term runtime library is meant to include the code of the runtime system itself, even though much of that code cannot be directly reached via a library call.

For example, some language features that can be performed only (or are more efficient or accurate) at runtime are implemented in the runtime system and may be invoked via the runtime library API, e.g. some logic errors, array bounds checking, dynamic type checking, exception handling and possibly debugging functionality. For this reason, some programming bugs are not discovered until the program is tested in a "live" environment with real data, despite sophisticated compile-time checking and pre-release testing. In this case, the end user may encounter a runtime error message.

The concept of a runtime library should not be confused with an ordinary program library like that created by an application programmer or delivered by a third party, nor with a dynamic library, meaning a program library linked at run time.

===libffi===
FFI stands for Foreign Function Interface. A foreign function interface is the popular name for the interface that allows code written in one language to call code written in another language. The libffi was originally written by Anthony Green<ref>http://moxielogic.org/blog</ref>. The libffi library really only provides the lowest, machine dependent layer of a fully featured foreign function interface. A layer must exist above libffi that handles type conversions for values passed between the two languages.<ref>http://sourceware.org/libffi/</ref>
libffi is a foreign function interface library. It provides a C programming language interface for calling natively compiled functions given information about the target function at run time instead of compile time. It also implements the opposite functionality: libffi can produce a pointer to a function that can accept and decode any combination of arguments defined at run time.
libffi is most often used as a bridging technology between compiled and interpreted language implementations. libffi may also be used to implement plug-ins, where the plug-in's function signatures are not known at the time of creating the host application.
Notable users include Python, Haskell, Dalvik, F-Script, PyPy, PyObjC, RubyCocoa, JRuby, Rubinius, MacRuby, gcj, GNU Smalltalk, IcedTea, Cycript, Pawn, Squeak, Java Native Access, Racket,<ref>http://en.wikipedia.org/wiki/Libffi#cite_note-2</ref> Embeddable Common Lisp and Mozilla.<ref>http://en.wikipedia.org/wiki/Libffi#cite_note-3</ref>
On Mac OS X libffi is commonly used with BridgeSupport, which provides programming language neutral descriptions of framework interfaces, and Nu which binds direct Objective-C access from Lisp.
libffi has been widely ported and is released under a MIT license.

===Ruby-FFI===
Ruby-FFI<ref>https://github.com/ffi/ffi/wiki</ref> is a Foreign Function Interface extension for Ruby. It is an FFI extension doesn't need compilation and can be used on multi-platform and multi-implementation. Ruby-FFI extension is easy to read,write and maintain. In addition, it is impervious to changes in the internal Ruby API.
====Overall Architecture====
Using Ruby-FFI, you can use native libraries from Ruby without writing a single line of native code. Ruby-FFI takes care of all of the cross Ruby implementation (MRI, JRuby, Rubinius, MacRuby, etc) and platform specific issues so that you can focus on writing and testing your Ruby code.
As FFI is effectively a bridge between the multiple worlds of Ruby implementations and multiple platform types, you might suffer a bit of cognitive dissonance trying to pull all the pieces together. When we develop in Ruby we tend to think in higher level terms, and don't so much concern ourselves with the lower level issues.
====Core Components====
Ruby-FFI has a number of useful components. Investing the time to understand FFI's components and capabilities will pay off as you begin using FFI. That said, it's nice to have an idea which components you should look at first. Understanding the following core modules and classes is a great way to start getting FFI's capabilities.

*'''FFI::Library'''
Along with require 'ffi', this module brings FFI's powerful native library interfacing capabilities into your Ruby code as a DSL. Typically you extend your custom module with this one, specify the native libraries and their calling conventions, prototype the native library's functions and structs in Ruby, and then start using the native library's API from Ruby.
*'''FFI::Pointer'''
Wraps native memory allocated by a third party library. It provides a number of methods for transferring data from unmanaged native memory to Ruby-managed native memory (FFI::MemoryPointer). The native memory wrapped by this class is not freed during garbage collection runs.
*'''FFI::MemoryPointer'''
Allows for Ruby code to allocate native memory and pass it to non-Ruby libraries. Lifecycle management (allocation and deallocation) are handled by this class, so when it gets garbage collected the native memory is also freed.
*'''FFI::Struct and FFI::Union'''

==How does it work?<ref>http://www.rubyinside.com/ruby-ffi-library-calling-external-libraries-now-easier-1293.html</ref>==
The many compiled bridges between external libraries and Ruby pose a problem for alternate implementations like JRuby, because of the complexity involved in exposing internals of the implementation or expensive serialization in both directions. Instead, an interface is necessary so that instead of developing libraries that act only as unique bridges to others, we can just have one library that provides the interface to any arbitrary library of our choice.

Ruby already has a library called "dl" that makes it possible to dynamically link external libraries with Ruby. It's a bit arcane though, and Charles points out that it's not widely used "because of real or perceived bugs." Given this, and given the need for an implementation that can be compatible with JRuby, Wayne Meissner has developed "FFI", a new Ruby library that provides "Foreign Function Interface" features to Ruby.
===Progress of FFI<ref>http://blog.headius.com/2008/10/ffi-for-ruby-now-available.html</ref>===
One of the largest problems plaguing Ruby implementations is the ever-painful story of "extensions". In general, these take the form of a dynamic library, usually written in C, that plugs into and calls Ruby's native API as exposed through ruby.h and libruby. Ignoring for the moment the fact that this API exposes way more of Ruby's internals than it should, extensions present a very difficult problem for other implementations:

Do we support them or not?

In many cases, this question is answered for us; most extensions require access to object internals we can't expose, or can't expose without extremely expensive copying back and forth. But there's also a silver lining: the vast majority of C-based extensions exist solely to wrap another library.

Isn't it obvious what's needed here?

This problem has been tackled by a number of libraries on a number of platforms. On the JVM, there's Java Native Access (JNA). On Python, there's ctypes. And even on Ruby, there's the "dl" stdlib, wrapping libdl for programmatic access to dynamic libraries. But dl is not widely used, because of real or perceived bugs and a rather arcane API. Something better is needed.

Wayne is one of the primary maintainers of JNA, and has recently spent time on a new higher-performance version of it called JFFI. Wayne also became a JRuby committer this spring, and perhaps his most impressive contribution to date is a full FFI library for JRuby, based on JNA (eventually JFFI, once we migrate fully) and implementing the full set of what we and Evan agreed would be "FFI API 1.0". We shipped the completed FFI support in JRuby 1.1.4.

The "Passwd" and "Group" structures for functions like 'getpwuid':
<pre>
module Etc
class Passwd < FFI::Struct
layout :pw_name, :string, 0,
:pw_passwd, :string, 4,
:pw_uid, :uint, 8,
:pw_gid, :uint, 12,
:pw_dir, :string, 20,
:pw_shell, :string, 24
end
class Group < FFI::Struct
layout :gr_name, :string, 0,
:gr_gid, :uint, 8
end
end
</pre>

In JRuby 1.1.5, we've taken another step forward with the API, adding support for callbacks. How would we represent a callback you pass into a C function from Ruby?

Binding and calling "qsort" with an array of integers:
<pre>
require 'ffi'

module LibC
extend FFI::Library
callback :qsort_cmp, [ :pointer, :pointer ], :int
attach_function :qsort, [ :pointer, :int, :int, :qsort_cmp ], :int
end

p = MemoryPointer.new(:int, 2)
p.put_array_of_int32(0, [ 2, 1 ])
puts "Before qsort #{p.get_array_of_int32(0, 2).join(', ')}"
LibC.qsort(p, 2, 4) do |p1, p2|
i1 = p1.get_int32(0)
i2 = p2.get_int32(0)
i1 < i2 ? -1 : i1 > i2 ? 1 : 0
end
puts "After qsort #{p.get_array_of_int32(0, 2).join(', ')}"
</pre>

What good is having such a library if it doesn't run everywhere? Up until recently, only Rubinius and JRuby supported FFI, which made our case for cross-implementation use pretty weak. Even though we were getting good use out of FFI, there was no motivation for anyone to use it in general, since the standard Ruby implementation had no support.

That is, until Wayne pulled another rabbit out of his hat and implemented FFI for C Ruby as well. The JRuby team is proud to announce a wholly non-JRuby library: FFI is now available on Ruby 1.9 and Ruby 1.8.6/7, in addition to JRuby 1.1.4+ and Rubinius (though Rubinius does not yet support callbacks).

Session showing installation and use of FFI in C Ruby:
<pre>
$ sudo gem install ffi
Password:
Building native extensions. This could take a while...
Successfully installed ffi-0.1.1
1 gem installed
Installing ri documentation for ffi-0.1.1...
Installing RDoc documentation for ffi-0.1.1...
[headius @ cnutter:~]
$ irb
>> require 'ffi'
=> true
>> module RubyFFI
>> extend FFI::Library
>> attach_function :getuid, [], :uint
>> end
=> #<FFI::Invoker:0x1fe8c>
>> puts RubyFFI.getuid
501
=> nil
>>
</pre>

Our hope with JRuby's support of FFI and our release of FFI for C Ruby is that we may finally escape the hell of C extensions.

A key feature that's not well documented is the use of FFI's templating system to generate bindings based on the current platform's header files. Here's a sample from the "Etc" module above.

Etc module template, showing how to pull in header files and inspect a struct definition:

<pre>
module Etc
class Passwd < FFI::Struct
@@@
struct do |s|
s.include "sys/types.h"
s.include "pwd.h"

s.name "struct passwd"
s.field :pw_name, :string
s.field :pw_passwd, :string
s.field :pw_uid, :uint
s.field :pw_gid, :uint
s.field :pw_dir, :string
s.field :pw_shell, :string
end
@@@
end
class Group < FFI::Struct
@@@
struct do |s|
s.include "sys/types.h"
s.include "grp.h"

s.name "struct group"
s.field :gr_name, :string
s.field :gr_gid, :uint
end
@@@
end
end
</pre>

===Basic Usage of Ruby-FFI<ref>https://github.com/ffi/ffi/wiki/Basic-Usage</ref>===
Before showing the example, we would introduce several FFI's core components<ref>https://github.com/ffi/ffi/wiki/Core-Concepts#wiki-figure-1---overall-ffi-architecture</ref>. Understanding the following core modules and classes is a great way to start getting FFI's capabilities:

*FFI::Library - along with require 'ffi', this module provides FFI library interfacing capabilities into your Ruby code. Typically you need to extend your custom module with FFI::Library, specify the native libraries and their calling conventions, prototype the native library's functions and structs in Ruby, and then start using the native library's API from Ruby.
*FFI::Pointer - wraps native memory allocated by a third party library. It provides a number of methods for transferring data from unmanaged native memory to Ruby-managed native memory (FFI::MemoryPointer). The native memory wrapped by this class is not freed during garbage collection runs.
*FFI::MemoryPointer - allows for Ruby code to allocate native memory and pass it to non-Ruby libraries. Lifecycle management (allocation and deallocation) are handled by this class, so when it gets garbage collected the native memory is also freed.
*FFI::Struct and FFI::Union

Here is a "Hello, World" example how to use Ruby-FFI.

<pre>
require 'ffi'

module Hello
extend FFI::Library
ffi_lib FFI::Library::LIBC
attach_function :puts, [ :string ], :int
end

Hello.puts("Hello, World")
</pre>

The interesting part above is the attach_function call. It requests that a C function named puts which takes a :string argument and returns an :int, be attached to the Hello module.

The attach_function method locates the C function in a specific external library (i.e. libc in the example). The name of the function, the parameter types and the return type are needed. In the above example, attach_function locates a function named puts, which papameter type and return type are :string and :int respectively.

The typical parameter and return types<ref>https://github.com/ffi/ffi/wiki/Types</ref> are listed here:

* :char and :uchar - 8 bit signed and unsigned values
* :short and :ushort - 16 bit signed and unsigned values
* :int and :uint - 32 bit signed and unsigned values
* :long_long and :ulong_long - 64 bit signed and unsigned values
* :long and :ulong - native cpu word (32 bit or 64bit) signed and unsigned values. Equivalent to C 'long' type.
* :float and :double
* :string - C string, NULL terminated.
* :pointer - a C pointer

You can also pass the struct as parameter. For example:

<pre>
typedef struct _WHAT {
int d;
} WHAT;

int doit(WHAT w) {
printf("%d\n", w.d);
return w.d;
}
</pre>

<pre>
class WHAT < FFI::Struct
layout :d, :int
end
attach_function 'doit', [ WHAT.by_value ], :int
</pre>

In the above 2 pieces of code, attach_function uses struct WHAT as a parameter type.

===Docs on FFI===
[http://wiki.jruby.org/wiki/Calling_C_from_JRuby Calling C from JRuby] 
[http://blog.segment7.net/articles/2008/01/15/rubinius-foreign-function-interfaceRubinius's Foreign Function Interface] 
[http://pluskid.lifegoo.com/?p=370On the Rubinius FFI] 

==Who uses it?==
The libffi library is useful to anyone trying to build a bridge between interpreted and natively compiled code. Some notable users include:
*CPython - the default, most-widely used implementation of the Python programming language uses libffi in the standard ctypes library.
*OpenJDK - the open-source implementation of the Java Platform Standard Edition uses libffi to bridge between the interpreter and native code for some platforms.
*js-ctypes - a foreign function interface for javascript that Mozilla will be shipping in Firefox 3.6.
*Dalvik - Dalvik is the virtual machine which runs the Java platform on Android mobile devices. libffi is used on Android ports for which no custom bridging code has been written.
*Java Native Access (JNA) - the JNI-free way to call native code from Java.
*Ruby-FFI - a Foreign Function Interface extension for Ruby.
*fsbv - Foreign Structure By Value is a foreign function interface library for Common Lisp that extends the standard CFFI package to include support for passing structure arguments by value.
*JSCocoa - call Objective-C code from javascript on Mac OSX and the iPhone (via the libffi-iphone port).
*PyObjC - call Objective-C code from Python on Mac OSX.
*RubyCocoa - call Objective-C code from Ruby on Mac OSX.
*PLT Scheme - call C code from this popular Scheme implementation (also used as the implementation platform for Paul Graham's new Lisp, Arc).
*gcj - the runtime library for the GNU Compiler for the Java Programming Language uses libffi to handle calls back and forth between interpreted and natively compiled code. gcj is part of the GCC, the GNU Compiler Collection.

==Supported Platforms==
Libffi has been ported to many different platforms. For specific configuration details and testing status, please refer to the wiki page [http://www.moxielogic.org/wiki/index.php?title=Libffi_3.0.13 here]

==Adoption==
[http://ruby-doc.org/stdlib-2.0/libdoc/fiddle/rdoc/index.html Fiddle] 
A libffi wrapper in the Ruby Standard Library 
[http://github.com/ffi/ffi Ruby-FFI] 
A Foreign Function Interface extension for Ruby. 
[http://en.wikipedia.org/wiki/RubyCocoa RubyCocoa] 
Call Objective-C code from Ruby on Mac OSX. 

==See Also==
http://en.wikipedia.org/wiki/Libffi

=='''References''' ==
<references/>
*http://github.com/atgreen/libffi/blob/master/LICENSE
*http://repository.readscheme.org/ftp/papers/sw2004/barzilay.pdf
*http://hg.mozilla.org/mozilla-central/file/2dc00d4b379a/js/ctypes/libffi
*https://developer.mozilla.org/en/js-ctypes
*https://developer.mozilla.org/en/js-ctypes/js-ctypes_reference
*http://blog.headius.com/2008/10/ffi-for-ruby-now-available.html
*http://www.rubyinside.com/ruby-ffi-library-calling-external-libraries-now-easier-1293.html
*http://sourceware.org/libffi/

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-10T21:17:20Z

Qjia2:

== '''Ruby libraries to load objects of other languages at run time''' ==

This is an advanced topic. Libraries are being developed where Ruby gems can load libraries (and even native code) of other languages.A few open-source projects like FFI are currently working on this. Previous version is available [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/ch1_1w21_w here]

__TOC__
==Introduction==
===Runtime Library===
In computer programming, a runtime library is the API used by a compiler to invoke some of the behaviors of a runtime system. The runtime system implements the execution model and other fundamental behaviors of a programming language. The compiler inserts calls to the runtime library into the executable binary. During execution (run time) of that computer program, execution of those calls to the runtime library cause communication between the application and the runtime system. This often includes functions for input and output, or for memory management.
The runtime library may implement a portion of the runtime system's behavior, but if one reads the code of the calls available, they typically are thin wrappers that simply package information and send it to the runtime system. However, sometimes the term runtime library is meant to include the code of the runtime system itself, even though much of that code cannot be directly reached via a library call.

For example, some language features that can be performed only (or are more efficient or accurate) at runtime are implemented in the runtime system and may be invoked via the runtime library API, e.g. some logic errors, array bounds checking, dynamic type checking, exception handling and possibly debugging functionality. For this reason, some programming bugs are not discovered until the program is tested in a "live" environment with real data, despite sophisticated compile-time checking and pre-release testing. In this case, the end user may encounter a runtime error message.

The concept of a runtime library should not be confused with an ordinary program library like that created by an application programmer or delivered by a third party, nor with a dynamic library, meaning a program library linked at run time.

===libffi===
FFI stands for Foreign Function Interface. A foreign function interface is the popular name for the interface that allows code written in one language to call code written in another language. The libffi was originally written by Anthony Green<ref>http://moxielogic.org/blog</ref>. The libffi library really only provides the lowest, machine dependent layer of a fully featured foreign function interface. A layer must exist above libffi that handles type conversions for values passed between the two languages.<ref>http://sourceware.org/libffi/</ref>
libffi is a foreign function interface library. It provides a C programming language interface for calling natively compiled functions given information about the target function at run time instead of compile time. It also implements the opposite functionality: libffi can produce a pointer to a function that can accept and decode any combination of arguments defined at run time.
libffi is most often used as a bridging technology between compiled and interpreted language implementations. libffi may also be used to implement plug-ins, where the plug-in's function signatures are not known at the time of creating the host application.
Notable users include Python, Haskell, Dalvik, F-Script, PyPy, PyObjC, RubyCocoa, JRuby, Rubinius, MacRuby, gcj, GNU Smalltalk, IcedTea, Cycript, Pawn, Squeak, Java Native Access, Racket,<ref>http://en.wikipedia.org/wiki/Libffi#cite_note-2</ref> Embeddable Common Lisp and Mozilla.<ref>http://en.wikipedia.org/wiki/Libffi#cite_note-3</ref>
On Mac OS X libffi is commonly used with BridgeSupport, which provides programming language neutral descriptions of framework interfaces, and Nu which binds direct Objective-C access from Lisp.
libffi has been widely ported and is released under a MIT license.

===Ruby-FFI===
Ruby-FFI<ref>https://github.com/ffi/ffi/wiki</ref> is a Foreign Function Interface extension for Ruby. It is an FFI extension doesn't need compilation and can be used on multi-platform and multi-implementation. Ruby-FFI extension is easy to read,write and maintain. In addition, it is impervious to changes in the internal Ruby API.
====Core Components====
Ruby-FFI has a number of useful components. Investing the time to understand FFI's components and capabilities will pay off as you begin using FFI. That said, it's nice to have an idea which components you should look at first. Understanding the following core modules and classes is a great way to start getting FFI's capabilities.

*'''FFI::Library'''
Along with require 'ffi', this module brings FFI's powerful native library interfacing capabilities into your Ruby code as a DSL. Typically you extend your custom module with this one, specify the native libraries and their calling conventions, prototype the native library's functions and structs in Ruby, and then start using the native library's API from Ruby.
*'''FFI::Pointer'''
Wraps native memory allocated by a third party library. It provides a number of methods for transferring data from unmanaged native memory to Ruby-managed native memory (FFI::MemoryPointer). The native memory wrapped by this class is not freed during garbage collection runs.
*'''FFI::MemoryPointer'''
Allows for Ruby code to allocate native memory and pass it to non-Ruby libraries. Lifecycle management (allocation and deallocation) are handled by this class, so when it gets garbage collected the native memory is also freed.
*'''FFI::Struct and FFI::Union'''

==How does it work?<ref>http://www.rubyinside.com/ruby-ffi-library-calling-external-libraries-now-easier-1293.html</ref>==
The many compiled bridges between external libraries and Ruby pose a problem for alternate implementations like JRuby, because of the complexity involved in exposing internals of the implementation or expensive serialization in both directions. Instead, an interface is necessary so that instead of developing libraries that act only as unique bridges to others, we can just have one library that provides the interface to any arbitrary library of our choice.

Ruby already has a library called "dl" that makes it possible to dynamically link external libraries with Ruby. It's a bit arcane though, and Charles points out that it's not widely used "because of real or perceived bugs." Given this, and given the need for an implementation that can be compatible with JRuby, Wayne Meissner has developed "FFI", a new Ruby library that provides "Foreign Function Interface" features to Ruby.
===Progress of FFI<ref>http://blog.headius.com/2008/10/ffi-for-ruby-now-available.html</ref>===
One of the largest problems plaguing Ruby implementations is the ever-painful story of "extensions". In general, these take the form of a dynamic library, usually written in C, that plugs into and calls Ruby's native API as exposed through ruby.h and libruby. Ignoring for the moment the fact that this API exposes way more of Ruby's internals than it should, extensions present a very difficult problem for other implementations:

Do we support them or not?

In many cases, this question is answered for us; most extensions require access to object internals we can't expose, or can't expose without extremely expensive copying back and forth. But there's also a silver lining: the vast majority of C-based extensions exist solely to wrap another library.

Isn't it obvious what's needed here?

This problem has been tackled by a number of libraries on a number of platforms. On the JVM, there's Java Native Access (JNA). On Python, there's ctypes. And even on Ruby, there's the "dl" stdlib, wrapping libdl for programmatic access to dynamic libraries. But dl is not widely used, because of real or perceived bugs and a rather arcane API. Something better is needed.

Wayne is one of the primary maintainers of JNA, and has recently spent time on a new higher-performance version of it called JFFI. Wayne also became a JRuby committer this spring, and perhaps his most impressive contribution to date is a full FFI library for JRuby, based on JNA (eventually JFFI, once we migrate fully) and implementing the full set of what we and Evan agreed would be "FFI API 1.0". We shipped the completed FFI support in JRuby 1.1.4.

The "Passwd" and "Group" structures for functions like 'getpwuid':
<pre>
module Etc
class Passwd < FFI::Struct
layout :pw_name, :string, 0,
:pw_passwd, :string, 4,
:pw_uid, :uint, 8,
:pw_gid, :uint, 12,
:pw_dir, :string, 20,
:pw_shell, :string, 24
end
class Group < FFI::Struct
layout :gr_name, :string, 0,
:gr_gid, :uint, 8
end
end
</pre>

In JRuby 1.1.5, we've taken another step forward with the API, adding support for callbacks. How would we represent a callback you pass into a C function from Ruby?

Binding and calling "qsort" with an array of integers:
<pre>
require 'ffi'

module LibC
extend FFI::Library
callback :qsort_cmp, [ :pointer, :pointer ], :int
attach_function :qsort, [ :pointer, :int, :int, :qsort_cmp ], :int
end

p = MemoryPointer.new(:int, 2)
p.put_array_of_int32(0, [ 2, 1 ])
puts "Before qsort #{p.get_array_of_int32(0, 2).join(', ')}"
LibC.qsort(p, 2, 4) do |p1, p2|
i1 = p1.get_int32(0)
i2 = p2.get_int32(0)
i1 < i2 ? -1 : i1 > i2 ? 1 : 0
end
puts "After qsort #{p.get_array_of_int32(0, 2).join(', ')}"
</pre>

What good is having such a library if it doesn't run everywhere? Up until recently, only Rubinius and JRuby supported FFI, which made our case for cross-implementation use pretty weak. Even though we were getting good use out of FFI, there was no motivation for anyone to use it in general, since the standard Ruby implementation had no support.

That is, until Wayne pulled another rabbit out of his hat and implemented FFI for C Ruby as well. The JRuby team is proud to announce a wholly non-JRuby library: FFI is now available on Ruby 1.9 and Ruby 1.8.6/7, in addition to JRuby 1.1.4+ and Rubinius (though Rubinius does not yet support callbacks).

Session showing installation and use of FFI in C Ruby:
<pre>
$ sudo gem install ffi
Password:
Building native extensions. This could take a while...
Successfully installed ffi-0.1.1
1 gem installed
Installing ri documentation for ffi-0.1.1...
Installing RDoc documentation for ffi-0.1.1...
[headius @ cnutter:~]
$ irb
>> require 'ffi'
=> true
>> module RubyFFI
>> extend FFI::Library
>> attach_function :getuid, [], :uint
>> end
=> #<FFI::Invoker:0x1fe8c>
>> puts RubyFFI.getuid
501
=> nil
>>
</pre>

Our hope with JRuby's support of FFI and our release of FFI for C Ruby is that we may finally escape the hell of C extensions.

A key feature that's not well documented is the use of FFI's templating system to generate bindings based on the current platform's header files. Here's a sample from the "Etc" module above.

Etc module template, showing how to pull in header files and inspect a struct definition:

<pre>
module Etc
class Passwd < FFI::Struct
@@@
struct do |s|
s.include "sys/types.h"
s.include "pwd.h"

s.name "struct passwd"
s.field :pw_name, :string
s.field :pw_passwd, :string
s.field :pw_uid, :uint
s.field :pw_gid, :uint
s.field :pw_dir, :string
s.field :pw_shell, :string
end
@@@
end
class Group < FFI::Struct
@@@
struct do |s|
s.include "sys/types.h"
s.include "grp.h"

s.name "struct group"
s.field :gr_name, :string
s.field :gr_gid, :uint
end
@@@
end
end
</pre>

===Basic Usage of Ruby-FFI<ref>https://github.com/ffi/ffi/wiki/Basic-Usage</ref>===
Before showing the example, we would introduce several FFI's core components<ref>https://github.com/ffi/ffi/wiki/Core-Concepts#wiki-figure-1---overall-ffi-architecture</ref>. Understanding the following core modules and classes is a great way to start getting FFI's capabilities:

*FFI::Library - along with require 'ffi', this module provides FFI library interfacing capabilities into your Ruby code. Typically you need to extend your custom module with FFI::Library, specify the native libraries and their calling conventions, prototype the native library's functions and structs in Ruby, and then start using the native library's API from Ruby.
*FFI::Pointer - wraps native memory allocated by a third party library. It provides a number of methods for transferring data from unmanaged native memory to Ruby-managed native memory (FFI::MemoryPointer). The native memory wrapped by this class is not freed during garbage collection runs.
*FFI::MemoryPointer - allows for Ruby code to allocate native memory and pass it to non-Ruby libraries. Lifecycle management (allocation and deallocation) are handled by this class, so when it gets garbage collected the native memory is also freed.
*FFI::Struct and FFI::Union

Here is a "Hello, World" example how to use Ruby-FFI.

<pre>
require 'ffi'

module Hello
extend FFI::Library
ffi_lib FFI::Library::LIBC
attach_function :puts, [ :string ], :int
end

Hello.puts("Hello, World")
</pre>

The interesting part above is the attach_function call. It requests that a C function named puts which takes a :string argument and returns an :int, be attached to the Hello module.

The attach_function method locates the C function in a specific external library (i.e. libc in the example). The name of the function, the parameter types and the return type are needed. In the above example, attach_function locates a function named puts, which papameter type and return type are :string and :int respectively.

The typical parameter and return types<ref>https://github.com/ffi/ffi/wiki/Types</ref> are listed here:

* :char and :uchar - 8 bit signed and unsigned values
* :short and :ushort - 16 bit signed and unsigned values
* :int and :uint - 32 bit signed and unsigned values
* :long_long and :ulong_long - 64 bit signed and unsigned values
* :long and :ulong - native cpu word (32 bit or 64bit) signed and unsigned values. Equivalent to C 'long' type.
* :float and :double
* :string - C string, NULL terminated.
* :pointer - a C pointer

You can also pass the struct as parameter. For example:

<pre>
typedef struct _WHAT {
int d;
} WHAT;

int doit(WHAT w) {
printf("%d\n", w.d);
return w.d;
}
</pre>

<pre>
class WHAT < FFI::Struct
layout :d, :int
end
attach_function 'doit', [ WHAT.by_value ], :int
</pre>

In the above 2 pieces of code, attach_function uses struct WHAT as a parameter type.

===Docs on FFI===
[http://wiki.jruby.org/wiki/Calling_C_from_JRuby Calling C from JRuby] 
[http://blog.segment7.net/articles/2008/01/15/rubinius-foreign-function-interfaceRubinius's Foreign Function Interface] 
[http://pluskid.lifegoo.com/?p=370On the Rubinius FFI] 

==Who uses it?==
The libffi library is useful to anyone trying to build a bridge between interpreted and natively compiled code. Some notable users include:
*CPython - the default, most-widely used implementation of the Python programming language uses libffi in the standard ctypes library.
*OpenJDK - the open-source implementation of the Java Platform Standard Edition uses libffi to bridge between the interpreter and native code for some platforms.
*js-ctypes - a foreign function interface for javascript that Mozilla will be shipping in Firefox 3.6.
*Dalvik - Dalvik is the virtual machine which runs the Java platform on Android mobile devices. libffi is used on Android ports for which no custom bridging code has been written.
*Java Native Access (JNA) - the JNI-free way to call native code from Java.
*Ruby-FFI - a Foreign Function Interface extension for Ruby.
*fsbv - Foreign Structure By Value is a foreign function interface library for Common Lisp that extends the standard CFFI package to include support for passing structure arguments by value.
*JSCocoa - call Objective-C code from javascript on Mac OSX and the iPhone (via the libffi-iphone port).
*PyObjC - call Objective-C code from Python on Mac OSX.
*RubyCocoa - call Objective-C code from Ruby on Mac OSX.
*PLT Scheme - call C code from this popular Scheme implementation (also used as the implementation platform for Paul Graham's new Lisp, Arc).
*gcj - the runtime library for the GNU Compiler for the Java Programming Language uses libffi to handle calls back and forth between interpreted and natively compiled code. gcj is part of the GCC, the GNU Compiler Collection.

==Supported Platforms==
Libffi has been ported to many different platforms. For specific configuration details and testing status, please refer to the wiki page [http://www.moxielogic.org/wiki/index.php?title=Libffi_3.0.13 here]

==Adoption==
[http://ruby-doc.org/stdlib-2.0/libdoc/fiddle/rdoc/index.html Fiddle] 
A libffi wrapper in the Ruby Standard Library 
[http://github.com/ffi/ffi Ruby-FFI] 
A Foreign Function Interface extension for Ruby. 
[http://en.wikipedia.org/wiki/RubyCocoa RubyCocoa] 
Call Objective-C code from Ruby on Mac OSX. 

==See Also==
http://en.wikipedia.org/wiki/Libffi

=='''References''' ==
<references/>
*http://github.com/atgreen/libffi/blob/master/LICENSE
*http://repository.readscheme.org/ftp/papers/sw2004/barzilay.pdf
*http://hg.mozilla.org/mozilla-central/file/2dc00d4b379a/js/ctypes/libffi
*https://developer.mozilla.org/en/js-ctypes
*https://developer.mozilla.org/en/js-ctypes/js-ctypes_reference
*http://blog.headius.com/2008/10/ffi-for-ruby-now-available.html
*http://www.rubyinside.com/ruby-ffi-library-calling-external-libraries-now-easier-1293.html
*http://sourceware.org/libffi/

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-10T21:04:03Z

Qjia2:

== '''Ruby libraries to load objects of other languages at run time''' ==

This is an advanced topic. Libraries are being developed where Ruby gems can load libraries (and even native code) of other languages.A few open-source projects like FFI are currently working on this. Previous version is available [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2013/ch1_1w21_w here]

__TOC__
==Introduction==
===Runtime Library===
In computer programming, a runtime library is the API used by a compiler to invoke some of the behaviors of a runtime system. The runtime system implements the execution model and other fundamental behaviors of a programming language. The compiler inserts calls to the runtime library into the executable binary. During execution (run time) of that computer program, execution of those calls to the runtime library cause communication between the application and the runtime system. This often includes functions for input and output, or for memory management.
The runtime library may implement a portion of the runtime system's behavior, but if one reads the code of the calls available, they typically are thin wrappers that simply package information and send it to the runtime system. However, sometimes the term runtime library is meant to include the code of the runtime system itself, even though much of that code cannot be directly reached via a library call.

For example, some language features that can be performed only (or are more efficient or accurate) at runtime are implemented in the runtime system and may be invoked via the runtime library API, e.g. some logic errors, array bounds checking, dynamic type checking, exception handling and possibly debugging functionality. For this reason, some programming bugs are not discovered until the program is tested in a "live" environment with real data, despite sophisticated compile-time checking and pre-release testing. In this case, the end user may encounter a runtime error message.

The concept of a runtime library should not be confused with an ordinary program library like that created by an application programmer or delivered by a third party, nor with a dynamic library, meaning a program library linked at run time.

===libffi===
FFI stands for Foreign Function Interface. A foreign function interface is the popular name for the interface that allows code written in one language to call code written in another language. The libffi was originally written by Anthony Green<ref>http://moxielogic.org/blog</ref>. The libffi library really only provides the lowest, machine dependent layer of a fully featured foreign function interface. A layer must exist above libffi that handles type conversions for values passed between the two languages.<ref>http://sourceware.org/libffi/</ref>
libffi is a foreign function interface library. It provides a C programming language interface for calling natively compiled functions given information about the target function at run time instead of compile time. It also implements the opposite functionality: libffi can produce a pointer to a function that can accept and decode any combination of arguments defined at run time.
libffi is most often used as a bridging technology between compiled and interpreted language implementations. libffi may also be used to implement plug-ins, where the plug-in's function signatures are not known at the time of creating the host application.
Notable users include Python, Haskell, Dalvik, F-Script, PyPy, PyObjC, RubyCocoa, JRuby, Rubinius, MacRuby, gcj, GNU Smalltalk, IcedTea, Cycript, Pawn, Squeak, Java Native Access, Racket,<ref>http://en.wikipedia.org/wiki/Libffi#cite_note-2</ref> Embeddable Common Lisp and Mozilla.<ref>http://en.wikipedia.org/wiki/Libffi#cite_note-3</ref>
On Mac OS X libffi is commonly used with BridgeSupport, which provides programming language neutral descriptions of framework interfaces, and Nu which binds direct Objective-C access from Lisp.
libffi has been widely ported and is released under a MIT license.

===Ruby-FFI===
Ruby-FFI<ref>https://github.com/ffi/ffi/wiki</ref> is a Foreign Function Interface extension for Ruby. It is an FFI extension doesn't need compilation and can be used on multi-platform and multi-implementation. Ruby-FFI extension is easy to read,write and maintain. In addition, it is impervious to changes in the internal Ruby API.

==How does it work?<ref>http://www.rubyinside.com/ruby-ffi-library-calling-external-libraries-now-easier-1293.html</ref>==
The many compiled bridges between external libraries and Ruby pose a problem for alternate implementations like JRuby, because of the complexity involved in exposing internals of the implementation or expensive serialization in both directions. Instead, an interface is necessary so that instead of developing libraries that act only as unique bridges to others, we can just have one library that provides the interface to any arbitrary library of our choice.

Ruby already has a library called "dl" that makes it possible to dynamically link external libraries with Ruby. It's a bit arcane though, and Charles points out that it's not widely used "because of real or perceived bugs." Given this, and given the need for an implementation that can be compatible with JRuby, Wayne Meissner has developed "FFI", a new Ruby library that provides "Foreign Function Interface" features to Ruby.
===Progress of FFI<ref>http://blog.headius.com/2008/10/ffi-for-ruby-now-available.html</ref>===
One of the largest problems plaguing Ruby implementations is the ever-painful story of "extensions". In general, these take the form of a dynamic library, usually written in C, that plugs into and calls Ruby's native API as exposed through ruby.h and libruby. Ignoring for the moment the fact that this API exposes way more of Ruby's internals than it should, extensions present a very difficult problem for other implementations:

Do we support them or not?

In many cases, this question is answered for us; most extensions require access to object internals we can't expose, or can't expose without extremely expensive copying back and forth. But there's also a silver lining: the vast majority of C-based extensions exist solely to wrap another library.

Isn't it obvious what's needed here?

This problem has been tackled by a number of libraries on a number of platforms. On the JVM, there's Java Native Access (JNA). On Python, there's ctypes. And even on Ruby, there's the "dl" stdlib, wrapping libdl for programmatic access to dynamic libraries. But dl is not widely used, because of real or perceived bugs and a rather arcane API. Something better is needed.

Wayne is one of the primary maintainers of JNA, and has recently spent time on a new higher-performance version of it called JFFI. Wayne also became a JRuby committer this spring, and perhaps his most impressive contribution to date is a full FFI library for JRuby, based on JNA (eventually JFFI, once we migrate fully) and implementing the full set of what we and Evan agreed would be "FFI API 1.0". We shipped the completed FFI support in JRuby 1.1.4.

The "Passwd" and "Group" structures for functions like 'getpwuid':
<pre>
module Etc
class Passwd < FFI::Struct
layout :pw_name, :string, 0,
:pw_passwd, :string, 4,
:pw_uid, :uint, 8,
:pw_gid, :uint, 12,
:pw_dir, :string, 20,
:pw_shell, :string, 24
end
class Group < FFI::Struct
layout :gr_name, :string, 0,
:gr_gid, :uint, 8
end
end
</pre>

In JRuby 1.1.5, we've taken another step forward with the API, adding support for callbacks. How would we represent a callback you pass into a C function from Ruby?

Binding and calling "qsort" with an array of integers:
<pre>
require 'ffi'

module LibC
extend FFI::Library
callback :qsort_cmp, [ :pointer, :pointer ], :int
attach_function :qsort, [ :pointer, :int, :int, :qsort_cmp ], :int
end

p = MemoryPointer.new(:int, 2)
p.put_array_of_int32(0, [ 2, 1 ])
puts "Before qsort #{p.get_array_of_int32(0, 2).join(', ')}"
LibC.qsort(p, 2, 4) do |p1, p2|
i1 = p1.get_int32(0)
i2 = p2.get_int32(0)
i1 < i2 ? -1 : i1 > i2 ? 1 : 0
end
puts "After qsort #{p.get_array_of_int32(0, 2).join(', ')}"
</pre>

What good is having such a library if it doesn't run everywhere? Up until recently, only Rubinius and JRuby supported FFI, which made our case for cross-implementation use pretty weak. Even though we were getting good use out of FFI, there was no motivation for anyone to use it in general, since the standard Ruby implementation had no support.

That is, until Wayne pulled another rabbit out of his hat and implemented FFI for C Ruby as well. The JRuby team is proud to announce a wholly non-JRuby library: FFI is now available on Ruby 1.9 and Ruby 1.8.6/7, in addition to JRuby 1.1.4+ and Rubinius (though Rubinius does not yet support callbacks).

Session showing installation and use of FFI in C Ruby:
<pre>
$ sudo gem install ffi
Password:
Building native extensions. This could take a while...
Successfully installed ffi-0.1.1
1 gem installed
Installing ri documentation for ffi-0.1.1...
Installing RDoc documentation for ffi-0.1.1...
[headius @ cnutter:~]
$ irb
>> require 'ffi'
=> true
>> module RubyFFI
>> extend FFI::Library
>> attach_function :getuid, [], :uint
>> end
=> #<FFI::Invoker:0x1fe8c>
>> puts RubyFFI.getuid
501
=> nil
>>
</pre>

Our hope with JRuby's support of FFI and our release of FFI for C Ruby is that we may finally escape the hell of C extensions.

A key feature that's not well documented is the use of FFI's templating system to generate bindings based on the current platform's header files. Here's a sample from the "Etc" module above.

Etc module template, showing how to pull in header files and inspect a struct definition:

<pre>
module Etc
class Passwd < FFI::Struct
@@@
struct do |s|
s.include "sys/types.h"
s.include "pwd.h"

s.name "struct passwd"
s.field :pw_name, :string
s.field :pw_passwd, :string
s.field :pw_uid, :uint
s.field :pw_gid, :uint
s.field :pw_dir, :string
s.field :pw_shell, :string
end
@@@
end
class Group < FFI::Struct
@@@
struct do |s|
s.include "sys/types.h"
s.include "grp.h"

s.name "struct group"
s.field :gr_name, :string
s.field :gr_gid, :uint
end
@@@
end
end
</pre>

===Basic Usage of Ruby-FFI<ref>https://github.com/ffi/ffi/wiki/Basic-Usage</ref>===
Before showing the example, we would introduce several FFI's core components<ref>https://github.com/ffi/ffi/wiki/Core-Concepts#wiki-figure-1---overall-ffi-architecture</ref>. Understanding the following core modules and classes is a great way to start getting FFI's capabilities:

*FFI::Library - along with require 'ffi', this module provides FFI library interfacing capabilities into your Ruby code. Typically you need to extend your custom module with FFI::Library, specify the native libraries and their calling conventions, prototype the native library's functions and structs in Ruby, and then start using the native library's API from Ruby.
*FFI::Pointer - wraps native memory allocated by a third party library. It provides a number of methods for transferring data from unmanaged native memory to Ruby-managed native memory (FFI::MemoryPointer). The native memory wrapped by this class is not freed during garbage collection runs.
*FFI::MemoryPointer - allows for Ruby code to allocate native memory and pass it to non-Ruby libraries. Lifecycle management (allocation and deallocation) are handled by this class, so when it gets garbage collected the native memory is also freed.
*FFI::Struct and FFI::Union

Here is a "Hello, World" example how to use Ruby-FFI.

<pre>
require 'ffi'

module Hello
extend FFI::Library
ffi_lib FFI::Library::LIBC
attach_function :puts, [ :string ], :int
end

Hello.puts("Hello, World")
</pre>

The interesting part above is the attach_function call. It requests that a C function named puts which takes a :string argument and returns an :int, be attached to the Hello module.

The attach_function method locates the C function in a specific external library (i.e. libc in the example). The name of the function, the parameter types and the return type are needed. In the above example, attach_function locates a function named puts, which papameter type and return type are :string and :int respectively.

The typical parameter and return types<ref>https://github.com/ffi/ffi/wiki/Types</ref> are listed here:

* :char and :uchar - 8 bit signed and unsigned values
* :short and :ushort - 16 bit signed and unsigned values
* :int and :uint - 32 bit signed and unsigned values
* :long_long and :ulong_long - 64 bit signed and unsigned values
* :long and :ulong - native cpu word (32 bit or 64bit) signed and unsigned values. Equivalent to C 'long' type.
* :float and :double
* :string - C string, NULL terminated.
* :pointer - a C pointer

You can also pass the struct as parameter. For example:

<pre>
typedef struct _WHAT {
int d;
} WHAT;

int doit(WHAT w) {
printf("%d\n", w.d);
return w.d;
}
</pre>

<pre>
class WHAT < FFI::Struct
layout :d, :int
end
attach_function 'doit', [ WHAT.by_value ], :int
</pre>

In the above 2 pieces of code, attach_function uses struct WHAT as a parameter type.

===Docs on FFI===
[http://wiki.jruby.org/wiki/Calling_C_from_JRuby Calling C from JRuby] 
[http://blog.segment7.net/articles/2008/01/15/rubinius-foreign-function-interfaceRubinius's Foreign Function Interface] 
[http://pluskid.lifegoo.com/?p=370On the Rubinius FFI] 

==Who uses it?==
The libffi library is useful to anyone trying to build a bridge between interpreted and natively compiled code. Some notable users include:
*CPython - the default, most-widely used implementation of the Python programming language uses libffi in the standard ctypes library.
*OpenJDK - the open-source implementation of the Java Platform Standard Edition uses libffi to bridge between the interpreter and native code for some platforms.
*js-ctypes - a foreign function interface for javascript that Mozilla will be shipping in Firefox 3.6.
*Dalvik - Dalvik is the virtual machine which runs the Java platform on Android mobile devices. libffi is used on Android ports for which no custom bridging code has been written.
*Java Native Access (JNA) - the JNI-free way to call native code from Java.
*Ruby-FFI - a Foreign Function Interface extension for Ruby.
*fsbv - Foreign Structure By Value is a foreign function interface library for Common Lisp that extends the standard CFFI package to include support for passing structure arguments by value.
*JSCocoa - call Objective-C code from javascript on Mac OSX and the iPhone (via the libffi-iphone port).
*PyObjC - call Objective-C code from Python on Mac OSX.
*RubyCocoa - call Objective-C code from Ruby on Mac OSX.
*PLT Scheme - call C code from this popular Scheme implementation (also used as the implementation platform for Paul Graham's new Lisp, Arc).
*gcj - the runtime library for the GNU Compiler for the Java Programming Language uses libffi to handle calls back and forth between interpreted and natively compiled code. gcj is part of the GCC, the GNU Compiler Collection.

==Supported Platforms==
Libffi has been ported to many different platforms. For specific configuration details and testing status, please refer to the wiki page [http://www.moxielogic.org/wiki/index.php?title=Libffi_3.0.13 here]

==Adoption==
[http://ruby-doc.org/stdlib-2.0/libdoc/fiddle/rdoc/index.html Fiddle] 
A libffi wrapper in the Ruby Standard Library 
[http://github.com/ffi/ffi Ruby-FFI] 
A Foreign Function Interface extension for Ruby. 
[http://en.wikipedia.org/wiki/RubyCocoa RubyCocoa] 
Call Objective-C code from Ruby on Mac OSX. 

==See Also==
http://en.wikipedia.org/wiki/Libffi

=='''References''' ==
<references/>
*http://github.com/atgreen/libffi/blob/master/LICENSE
*http://repository.readscheme.org/ftp/papers/sw2004/barzilay.pdf
*http://hg.mozilla.org/mozilla-central/file/2dc00d4b379a/js/ctypes/libffi
*https://developer.mozilla.org/en/js-ctypes
*https://developer.mozilla.org/en/js-ctypes/js-ctypes_reference
*http://blog.headius.com/2008/10/ffi-for-ruby-now-available.html
*http://www.rubyinside.com/ruby-ffi-library-calling-external-libraries-now-easier-1293.html
*http://sourceware.org/libffi/

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T22:51:42Z

Qjia2:

== '''Ruby libraries to load objects of other languages at run time''' ==
[http://en.wikipedia.org/wiki/Ruby_(programming_language) Ruby] is a dynamic, reflective, object-oriented, general-purpose programming language. It is easy to extend Ruby with new features by writing code in Ruby. But every now and then extending ruby with low-level languages, such as[http://en.wikipedia.org/wiki/C_(programming_language) C]/[http://en.wikipedia.org/wiki/C%2B%2B C++]/[http://en.wikipedia.org/wiki/Java_(programming_language) Java] is also necessary.

Currently, various kinds of languages codes could be invoked from within ruby. The extension for C/C++ and Java are focused here.

__TOC__

== '''Ruby C/C++ extensions<ref>http://java.ociweb.com/mark/NFJS/RubyCExtensions.pdf</ref>''' ==
By extending Ruby with C. The C libraries could be used directly in Ruby applications.
Ruby could call C codes in three ways: interpreter API, RubyInline, SWIG.
=== interpreter API ===
Ruby interpreter is implemented in C, its API can be used and no special API added for interacting with C like Java’s JNI is needed.

The files needed include:
*'''extconf.rb'''
Used to generate Makefile

Platform-specific Makefiles for compiling C extensions to Ruby is needed to be generated firstly.

A simple sample is like below:

create a file containing the following,
named extconf.rb by convention
<pre>
require 'mkmf'
extension_name = 'name'
dir_config(extension_name)
create_makefile(extension_name)
</pre>
And use by running
<pre>
ruby extconf.rb
make
</pre>
Then generates
<pre>
.so under UNIX/Linux
.so under Windows when building with Cygwin
.bundle under Mac OS X
</pre>

*'''C File'''
C codes to be invoked from Ruby

An example Hello.c is shown below
<pre>
#include <ruby.h>
#include <stdio.h>
// These C functions will be associated with
// methods of a Ruby class on the next page.
static VALUE hello(VALUE self, VALUE arg) {
char* name = RSTRING(arg)->ptr;
printf("Hello %s!\n", name);
return Qnil;
}
static VALUE goodbye(VALUE class) {
printf("Later dude!\n");
return Qnil;
}
// This is called when the Ruby interpreter loads this C extension.
// The part after "Init_" is the name of the C extension specified
// in extconf.rb, not the name of the C source file.
void Init_hello() {
// Create a Ruby module.
VALUE myModule = rb_define_module("MyModule");
// Create a Ruby class in this module.
// rb_cObject is defined in ruby.h
VALUE myClass =
rb_define_class_under(myModule, "MyClass", rb_cObject);
// Add an instance method to the Ruby class.
int arg_count = 1;
rb_define_method(myClass, "hello", hello, arg_count);
// Add a class method to the Ruby class.
arg_count = 0;
rb_define_module_function(myClass, "goodbye", goodbye, arg_count);
}
</pre>
*'''Ruby File'''
Ruby code that invokes C code

An example client.rb is shown as below
<pre>
require 'hello'
include MyModule # so MyClass doesn't need MyModule:: prefix
obj = MyClass.new # MyClass is defined in C
obj.hello('Mark') # calling an object method
MyClass.goodbye # calling a class method
</pre>

Finally we could build and run
<pre>
ruby extconf.rb
make
ruby client.rb
</pre>

Then the output will display as
<pre>
Hello Mark!
Later dude!
</pre>

=== RubyInline ===
[http://www.zenspider.com/ZSS/Products/RubyInline/ RubyInline] allows C code to be imbedded in Ruby code. It automatically determines if the code in question has changed and builds it only when necessary. The extensions are then automatically loaded into the class/module that defines it.

To setup RubyInline, just use
<pre>
gem install rubyinline
</pre>

=== SWIG ===
[http://en.wikipedia.org/wiki/SWIG SWIG] is a software development tool that connects programs written in C and C++ with a variety of high-level programming languages. SWIG is used with different types of target languages including common scripting languages such as Perl, PHP, Python, Tcl and Ruby.

As an example, building Ruby Extensions under Windows 95/NT is shown as below
Building a SWIG extension to Ruby under Windows 95/NT is roughly similar to the process used with Unix.
<pre>
C:\swigtest> ruby extconf.rb
C:\swigtest> nmake
C:\swigtest> nmake install
</pre>

== '''Ruby JAVA extensions''' ==
To extend Ruby with JAVA, the [http://jruby.org/ JRuby] is a good tool to use. JRuby is a high performance, stable, fully threaded Java implementation of the Ruby programming language. It is a Ruby interpreter written entirely in Java and can use Java capabilities from Ruby as well as can use Ruby capabilities from Java.
=== Using JRuby From Command-Line ===
*'''Steps to install'''
– download a binary release [http://jruby.org/ here]

– unzip/untar the downloaded archive

– set JRUBY_HOME environment variable to point to resulting directory

– add $JRUBY_HOME/bin to PATH
*'''Steps to use'''
– jruby {script-name}
*'''Example'''
– hello.rb
<pre>
name = ARGV[0] || "you"
puts "Hello #{name}!"
</pre>
– run with
<pre>
jruby hello.rb
</pre>
outputs
<pre>
Hello you!
</pre>
– run with
<pre>
jruby hello.rb Mark
</pre>
outputs
<pre>
Hello Mark
</pre>
=== Using JAVA Classes in JRuby ===
To use java classes in JRuby, the program must require 'java'

There several options to provide full names of Java classes to be used in JRuby
*'''option #1'''
provide full name when using
<pre>
frame = javax.swing.JFrame.new('My Title')
</pre>
*'''option #2'''
assign full class name to a constant
<pre>
JFrame = javax.swing.JFrame
frame = JFrame.new('My Title')
</pre>
*'''option #3'''
use include_class
<pre>
include_class 'javax.swing.JFrame'
frame = JFrame.new('My Title')
</pre>
*'''option #4'''
use include_class with an alias
<pre>
include_class('java.lang.String') do |pkg_name, class_name|
"J#{class_name}"
end
msg = JString.new('My Message')
</pre>
*'''option #5'''
use include_package
<pre>
module Swing
include_package 'javax.swing'
end
frame = Swing::JFrame.new('My Title')
</pre>
== '''Summary''' ==

== '''See Also''' ==
*http://java.ociweb.com/mark/NFJS/JRuby.pdf
*http://java.ociweb.com/mark/NFJS/RubyCExtensions.pdf
*http://www.swig.org/
*http://www.zenspider.com/ZSS/Products/RubyInline/
*http://en.wikibooks.org/wiki/Ruby_Programming/C_Extensions

== '''References''' ==
<references/>

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T22:51:11Z

Qjia2:

== '''Ruby libraries to load objects of other languages at run time''' ==
[http://en.wikipedia.org/wiki/Ruby_(programming_language) Ruby] is a dynamic, reflective, object-oriented, general-purpose programming language. It is easy to extend Ruby with new features by writing code in Ruby. But every now and then extending ruby with low-level languages, such as[http://en.wikipedia.org/wiki/C_(programming_language) C]/[http://en.wikipedia.org/wiki/C%2B%2B C++]/[http://en.wikipedia.org/wiki/Java_(programming_language) Java] is also necessary.

Currently, various kinds of languages codes could be invoked from within ruby. The extension for C/C++ and Java are focused here.

__TOC__

== '''Ruby C/C++ extensions<ref>http://java.ociweb.com/mark/NFJS/RubyCExtensions.pdf</ref>''' ==
By extending Ruby with C. The C libraries could be used directly in Ruby applications.
Ruby could call C codes in three ways: interpreter API, RubyInline, SWIG.
=== interpreter API ===
Ruby interpreter is implemented in C, its API can be used and no special API added for interacting with C like Java’s JNI is needed.

The files needed include:
*'''extconf.rb'''
Used to generate Makefile

Platform-specific Makefiles for compiling C extensions to Ruby is needed to be generated firstly.

A simple sample is like below:

create a file containing the following,
named extconf.rb by convention
<pre>
require 'mkmf'
extension_name = 'name'
dir_config(extension_name)
create_makefile(extension_name)
</pre>
And use by running
<pre>
ruby extconf.rb
make
</pre>
Then generates
<pre>
.so under UNIX/Linux
.so under Windows when building with Cygwin
.bundle under Mac OS X
</pre>

*'''C File'''
C codes to be invoked from Ruby

An example Hello.c is shown below
<pre>
#include <ruby.h>
#include <stdio.h>
// These C functions will be associated with
// methods of a Ruby class on the next page.
static VALUE hello(VALUE self, VALUE arg) {
char* name = RSTRING(arg)->ptr;
printf("Hello %s!\n", name);
return Qnil;
}
static VALUE goodbye(VALUE class) {
printf("Later dude!\n");
return Qnil;
}
// This is called when the Ruby interpreter loads this C extension.
// The part after "Init_" is the name of the C extension specified
// in extconf.rb, not the name of the C source file.
void Init_hello() {
// Create a Ruby module.
VALUE myModule = rb_define_module("MyModule");
// Create a Ruby class in this module.
// rb_cObject is defined in ruby.h
VALUE myClass =
rb_define_class_under(myModule, "MyClass", rb_cObject);
// Add an instance method to the Ruby class.
int arg_count = 1;
rb_define_method(myClass, "hello", hello, arg_count);
// Add a class method to the Ruby class.
arg_count = 0;
rb_define_module_function(myClass, "goodbye", goodbye, arg_count);
}
</pre>
*'''Ruby File'''
Ruby code that invokes C code

An example client.rb is shown as below
<pre>
require 'hello'
include MyModule # so MyClass doesn't need MyModule:: prefix
obj = MyClass.new # MyClass is defined in C
obj.hello('Mark') # calling an object method
MyClass.goodbye # calling a class method
</pre>

Finally we could build and run
<pre>
ruby extconf.rb
make
ruby client.rb
</pre>

Then the output will display as
<pre>
Hello Mark!
Later dude!
</pre>

=== RubyInline ===
[http://www.zenspider.com/ZSS/Products/RubyInline/ RubyInline] allows C code to be imbedded in Ruby code. It automatically determines if the code in question has changed and builds it only when necessary. The extensions are then automatically loaded into the class/module that defines it.

To setup RubyInline, just use
<pre>
gem install rubyinline
</pre>

=== SWIG ===
[http://en.wikipedia.org/wiki/SWIG SWIG] is a software development tool that connects programs written in C and C++ with a variety of high-level programming languages. SWIG is used with different types of target languages including common scripting languages such as Perl, PHP, Python, Tcl and Ruby.

As an example, building Ruby Extensions under Windows 95/NT is shown as below
Building a SWIG extension to Ruby under Windows 95/NT is roughly similar to the process used with Unix.
<pre>
C:\swigtest> ruby extconf.rb
C:\swigtest> nmake
C:\swigtest> nmake install
</pre>

== '''Ruby JAVA extensions''' ==
To extend Ruby with JAVA, the [http://jruby.org/ JRuby] is a good tool to use. JRuby is a high performance, stable, fully threaded Java implementation of the Ruby programming language. It is a Ruby interpreter written entirely in Java and can use Java capabilities from Ruby as well as can use Ruby capabilities from Java.
=== Using JRuby From Command-Line ===
*'''Steps to install'''
– download a binary release [http://jruby.org/ here]

– unzip/untar the downloaded archive

– set JRUBY_HOME environment variable to point to resulting directory

– add $JRUBY_HOME/bin to PATH
*'''Steps to use'''
– jruby {script-name}
*'''Example'''
– hello.rb
<pre>
name = ARGV[0] || "you"
puts "Hello #{name}!"
</pre>
– run with
<pre>
jruby hello.rb
</pre>
outputs
<pre>
Hello you!
</pre>
– run with
<pre>
jruby hello.rb Mark
</pre>
outputs
<pre>
Hello Mark
</pre>
=== Using JAVA Classes in JRuby ===
To use java classes in JRuby, the program must require 'java'

There several options to provide full names of Java classes to be used in JRuby
*'''option #1'''
provide full name when using
<pre>
frame = javax.swing.JFrame.new('My Title')
</pre>
*'''option #2'''
assign full class name to a constant
<pre>
JFrame = javax.swing.JFrame
frame = JFrame.new('My Title')
</pre>
*'''option #3'''
use include_class
<pre>
include_class 'javax.swing.JFrame'
frame = JFrame.new('My Title')
</pre>
*'''option #4'''
use include_class with an alias
<pre>
include_class('java.lang.String') do |pkg_name, class_name|
"J#{class_name}"
end
msg = JString.new('My Message')
</pre>
*'''option #5'''
use include_package
<pre>
module Swing
include_package 'javax.swing'
end
frame = Swing::JFrame.new('My Title')
</pre>

== '''See Also''' ==
*http://java.ociweb.com/mark/NFJS/JRuby.pdf
*http://java.ociweb.com/mark/NFJS/RubyCExtensions.pdf
*http://www.swig.org/
*http://www.zenspider.com/ZSS/Products/RubyInline/
*http://en.wikibooks.org/wiki/Ruby_Programming/C_Extensions

== '''References''' ==
<references/>

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T22:48:10Z

Qjia2:

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T22:42:20Z

Qjia2:

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T22:40:53Z

Qjia2:

== '''Ruby libraries to load objects of other languages at run time''' ==
[http://en.wikipedia.org/wiki/Ruby_(programming_language) Ruby] is a dynamic, reflective, object-oriented, general-purpose programming language. It is easy to extend Ruby with new features by writing code in Ruby. But every now and then extending ruby with low-level languages, such as[http://en.wikipedia.org/wiki/C_(programming_language) C]/[http://en.wikipedia.org/wiki/C%2B%2B C++]/[http://en.wikipedia.org/wiki/Java_(programming_language) Java] is also necessary.

Currently, various kinds of languages codes could be invoked from within ruby. The extension for C/C++ and Java are focused here.

__TOC__

== '''Ruby C/C++ extensions<ref>http://java.ociweb.com/mark/NFJS/RubyCExtensions.pdf</ref>''' ==
By extending Ruby with C. The C libraries could be used directly in Ruby applications.
Ruby could call C codes in three ways: interpreter API, RubyInline, SWIG.
=== interpreter API ===
Ruby interpreter is implemented in C, its API can be used and no special API added for interacting with C like Java’s JNI is needed.

The files needed include:
*'''extconf.rb'''
Used to generate Makefile

Platform-specific Makefiles for compiling C extensions to Ruby is needed to be generated firstly.

A simple sample is like below:

create a file containing the following,
named extconf.rb by convention
<pre>
require 'mkmf'
extension_name = 'name'
dir_config(extension_name)
create_makefile(extension_name)
</pre>
And use by running
<pre>
ruby extconf.rb
make
</pre>
Then generates
<pre>
.so under UNIX/Linux
.so under Windows when building with Cygwin
.bundle under Mac OS X
</pre>

*'''C File'''
C codes to be invoked from Ruby

An example Hello.c is shown below
<pre>
#include <ruby.h>
#include <stdio.h>
// These C functions will be associated with
// methods of a Ruby class on the next page.
static VALUE hello(VALUE self, VALUE arg) {
char* name = RSTRING(arg)->ptr;
printf("Hello %s!\n", name);
return Qnil;
}
static VALUE goodbye(VALUE class) {
printf("Later dude!\n");
return Qnil;
}
// This is called when the Ruby interpreter loads this C extension.
// The part after "Init_" is the name of the C extension specified
// in extconf.rb, not the name of the C source file.
void Init_hello() {
// Create a Ruby module.
VALUE myModule = rb_define_module("MyModule");
// Create a Ruby class in this module.
// rb_cObject is defined in ruby.h
VALUE myClass =
rb_define_class_under(myModule, "MyClass", rb_cObject);
// Add an instance method to the Ruby class.
int arg_count = 1;
rb_define_method(myClass, "hello", hello, arg_count);
// Add a class method to the Ruby class.
arg_count = 0;
rb_define_module_function(myClass, "goodbye", goodbye, arg_count);
}
</pre>
*'''Ruby File'''
Ruby code that invokes C code

An example client.rb is shown as below
<pre>
require 'hello'
include MyModule # so MyClass doesn't need MyModule:: prefix
obj = MyClass.new # MyClass is defined in C
obj.hello('Mark') # calling an object method
MyClass.goodbye # calling a class method
</pre>

Finally we could build and run
<pre>
ruby extconf.rb
make
ruby client.rb
</pre>

Then the output will display as
<pre>
Hello Mark!
Later dude!
</pre>

=== RubyInline ===
[http://www.zenspider.com/ZSS/Products/RubyInline/ RubyInline] allows C code to be imbedded in Ruby code. It automatically determines if the code in question has changed and builds it only when necessary. The extensions are then automatically loaded into the class/module that defines it.

To setup RubyInline, just use
<pre>
gem install rubyinline
</pre>

=== SWIG ===
[http://en.wikipedia.org/wiki/SWIG SWIG] is a software development tool that connects programs written in C and C++ with a variety of high-level programming languages. SWIG is used with different types of target languages including common scripting languages such as Perl, PHP, Python, Tcl and Ruby.

As an example, building Ruby Extensions under Windows 95/NT is shown as below
Building a SWIG extension to Ruby under Windows 95/NT is roughly similar to the process used with Unix.
<pre>
C:\swigtest> ruby extconf.rb
C:\swigtest> nmake
C:\swigtest> nmake install
</pre>

== '''Ruby JAVA extensions''' ==
To extend Ruby with JAVA, the [http://jruby.org/ JRuby] is a good tool to use. JRuby is a high performance, stable, fully threaded Java implementation of the Ruby programming language. It is a Ruby interpreter written entirely in Java and can use Java capabilities from Ruby as well as can use Ruby capabilities from Java.
=== Using JRuby From Command-Line ===
*'''Steps to install'''
– download a binary release [www.jruby.org here]

– unzip/untar the downloaded archive

– set JRUBY_HOME environment variable to point to resulting directory

– add $JRUBY_HOME/bin to PATH
*'''Steps to use'''
– jruby {script-name}
*'''Example'''
– hello.rb
<pre>
name = ARGV[0] || "you"
puts "Hello #{name}!"
</pre>
– run with
<pre>
jruby hello.rb
</pre>
outputs
<pre>
Hello you!
</pre>
– run with
<pre>
jruby hello.rb Mark
</pre>
outputs
<pre>
Hello Mark
</pre>

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T22:40:06Z

Qjia2:

== '''Ruby libraries to load objects of other languages at run time''' ==
[http://en.wikipedia.org/wiki/Ruby_(programming_language) Ruby] is a dynamic, reflective, object-oriented, general-purpose programming language. It is easy to extend Ruby with new features by writing code in Ruby. But every now and then extending ruby with low-level languages, such as[http://en.wikipedia.org/wiki/C_(programming_language) C]/[http://en.wikipedia.org/wiki/C%2B%2B C++]/[http://en.wikipedia.org/wiki/Java_(programming_language) Java] is also necessary.

Currently, various kinds of languages codes could be invoked from within ruby. The extension for C/C++ and Java are focused here.

__TOC__

== '''Ruby C/C++ extensions<ref>http://java.ociweb.com/mark/NFJS/RubyCExtensions.pdf</ref>''' ==
By extending Ruby with C. The C libraries could be used directly in Ruby applications.
Ruby could call C codes in three ways: interpreter API, RubyInline, SWIG.
=== interpreter API ===
Ruby interpreter is implemented in C, its API can be used and no special API added for interacting with C like Java’s JNI is needed.

The files needed include:
*'''extconf.rb'''
Used to generate Makefile

Platform-specific Makefiles for compiling C extensions to Ruby is needed to be generated firstly.

A simple sample is like below:

create a file containing the following,
named extconf.rb by convention
<pre>
require 'mkmf'
extension_name = 'name'
dir_config(extension_name)
create_makefile(extension_name)
</pre>
And use by running
<pre>
ruby extconf.rb
make
</pre>
Then generates
<pre>
.so under UNIX/Linux
.so under Windows when building with Cygwin
.bundle under Mac OS X
</pre>

*'''C File'''
C codes to be invoked from Ruby

An example Hello.c is shown below
<pre>
#include <ruby.h>
#include <stdio.h>
// These C functions will be associated with
// methods of a Ruby class on the next page.
static VALUE hello(VALUE self, VALUE arg) {
char* name = RSTRING(arg)->ptr;
printf("Hello %s!\n", name);
return Qnil;
}
static VALUE goodbye(VALUE class) {
printf("Later dude!\n");
return Qnil;
}
// This is called when the Ruby interpreter loads this C extension.
// The part after "Init_" is the name of the C extension specified
// in extconf.rb, not the name of the C source file.
void Init_hello() {
// Create a Ruby module.
VALUE myModule = rb_define_module("MyModule");
// Create a Ruby class in this module.
// rb_cObject is defined in ruby.h
VALUE myClass =
rb_define_class_under(myModule, "MyClass", rb_cObject);
// Add an instance method to the Ruby class.
int arg_count = 1;
rb_define_method(myClass, "hello", hello, arg_count);
// Add a class method to the Ruby class.
arg_count = 0;
rb_define_module_function(myClass, "goodbye", goodbye, arg_count);
}
</pre>
*'''Ruby File'''
Ruby code that invokes C code

An example client.rb is shown as below
<pre>
require 'hello'
include MyModule # so MyClass doesn't need MyModule:: prefix
obj = MyClass.new # MyClass is defined in C
obj.hello('Mark') # calling an object method
MyClass.goodbye # calling a class method
</pre>

Finally we could build and run
<pre>
ruby extconf.rb
make
ruby client.rb
</pre>

Then the output will display as
<pre>
Hello Mark!
Later dude!
</pre>

=== RubyInline ===
[http://www.zenspider.com/ZSS/Products/RubyInline/ RubyInline] allows C code to be imbedded in Ruby code. It automatically determines if the code in question has changed and builds it only when necessary. The extensions are then automatically loaded into the class/module that defines it.

To setup RubyInline, just use
<pre>
gem install rubyinline
</pre>

=== SWIG ===
[http://en.wikipedia.org/wiki/SWIG SWIG] is a software development tool that connects programs written in C and C++ with a variety of high-level programming languages. SWIG is used with different types of target languages including common scripting languages such as Perl, PHP, Python, Tcl and Ruby.

As an example, building Ruby Extensions under Windows 95/NT is shown as below
Building a SWIG extension to Ruby under Windows 95/NT is roughly similar to the process used with Unix.
<pre>
C:\swigtest> ruby extconf.rb
C:\swigtest> nmake
C:\swigtest> nmake install
</pre>

== '''Ruby JAVA extensions''' ==
To extend Ruby with JAVA, the [http://jruby.org/ JRuby] is a good tool to use. JRuby is a high performance, stable, fully threaded Java implementation of the Ruby programming language. It is a Ruby interpreter written entirely in Java and can use Java capabilities from Ruby as well as can use Ruby capabilities from Java.
=== Using JRuby From Command-Line ===
*'''Steps to install'''
– download a binary release [www.jruby.org here]
– unzip/untar the downloaded archive
– set JRUBY_HOME environment variable to point to resulting directory
– add $JRUBY_HOME/bin to PATH
*'''Steps to use'''
– jruby {script-name}
*'''Example'''
– hello.rb
<pre>
name = ARGV[0] || "you"
puts "Hello #{name}!"
</pre>
– run with
<pre>
jruby hello.rb
</pre>
outputs
<pre>
Hello you!
</pre>
– run with
<pre>
jruby hello.rb Mark
</pre>
outputs
<pre>
Hello Mark
</pre>

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T22:28:38Z

Qjia2:

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T22:22:16Z

Qjia2:

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T22:21:30Z

Qjia2:

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T21:57:30Z

Qjia2:

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T21:55:59Z

Qjia2:

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T21:50:48Z

Qjia2:

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T21:23:47Z

Qjia2:

CSC/ECE 517 Spring 2014/ch1 1w1h jg

2014-02-04T21:21:31Z

Qjia2: