WIP: change deleteXXX in ResultSet classes.

Author: pstaabp

lib/DB/Schema/ResultSet/Course.pm

@@ -169,18 +169,13 @@ C<as_result_set>, a boolean if the return is to be a result_set
 
 =head3 output
 
-The deleted course either as a C< DBIx::Class::ResultSet::Course> object or a hashref
-of the fields. See above.
+Nothing (undef) is returned.
 
 =cut
 
 sub deleteCourse ($self, %args) {
-	my $course_to_delete = $self->getCourse(info => getCourseInfo($args{info}), as_result_set => 1);
-
-	my $deleted_course = $course_to_delete->delete;
-	return $deleted_course if $args{as_result_set};
-
-	return { $course_to_delete->get_inflated_columns };
+	$self->getCourse(info => getCourseInfo($args{info}), as_result_set => 1)->delete;
+	return;
 }
 
 =head1 updateCourse

lib/DB/Schema/ResultSet/ProblemPool.pm

@@ -102,6 +102,27 @@ sub getProblemPool ($self, %args) {
 
 Add a problem pool for a given course
 
+=head3 arguments
+
+=over
+
+=item * C<params> a hashref specifying information on the added problem pool
+One must include either the C<course_id> or C<course_name> and the C<pool_name>.
+If there is not enough info to get the course and pool, a C<ParametersNeeded> exception is thrown.
+
+
+=item * C<as_result_set>: boolean
+
+If C<as_result_set> is true, then the user sets are returned as a C<ResultSet>.
+See C<DBIx::Class::ResultSet> for more information
+
+=back
+
+=head3 output
+
+Either a hashref of the added problem pool or a C<DBIx::Class::ResultSet::ProblemPool>
+if C<as_result_set> is true.
+
 =cut
 
 sub addProblemPool ($self, %args) {
@@ -147,6 +168,25 @@ sub addProblemPool ($self, %args) {
 
 updates the parameters of an existing problem pool
 
+=head3 arguments
+
+=over
+
+=item * C<info> a hashref specifying information on the problem pool
+One must include either the C<course_id> or C<course_name> and either the C<pool_name>
+or C<problem_pool_id>.  If there is not enough info to get the course and pool, a
+C<ParametersNeeded> exception is thrown.
+
+=item * C<params>: a hashref containing the information to be updated.
+
+=item * C<as_result_set>: boolean
+
+If C<as_result_set> is true, then the user sets are returned as a C<ResultSet>.
+See C<DBIx::Class::ResultSet> for more information
+
+=back
+
+
 =cut
 
 sub updateProblemPool ($self, %args) {
@@ -173,21 +213,36 @@ sub updateProblemPool ($self, %args) {
 	return { $updated_pool->get_columns };
 }
 
-=head2 updateProblemPool
+=head2 deleteProblemPool
 
-updates the parameters of an existing problem pool
+delete a Problem Pool
 
-=cut
+=head3 arguments
 
-sub deleteProblemPool ($self, %args) {
-	my $pool = $self->getProblemPool(info => $args{info}, as_result_set => 1);
+=over
 
-	DB::Exception::PoolNotInCourse->throws(error => 'The problem pool does not exist')
-		unless defined($pool);
+=item * C<info> a hashref specifying information on the problem pool
+One must include either the C<course_id> or C<course_name> and either the C<pool_name>
+or C<problem_pool_id>.  If there is not enough info to get the course and pool, a
+C<ParametersNeeded> exception is thrown.
 
-	my $deleted_pool = $pool->delete();
 
-	return $args{as_result_set} ? $deleted_pool : { $deleted_pool->get_columns };
+=item * C<as_result_set>: boolean
+
+If C<as_result_set> is true, then the user sets are returned as a C<ResultSet>.
+See C<DBIx::Class::ResultSet> for more information
+
+=back
+
+=head3 output
+
+Nothing (undef) is returned.
+
+=cut
+
+sub deleteProblemPool ($self, %args) {
+	$self->getProblemPool(info => $args{info}, as_result_set => 1)->delete;
+	return;
 }
 
 #####

lib/DB/Schema/ResultSet/ProblemSet.pm

@@ -509,19 +509,13 @@ if false, a hashrefs of ProblemSet.
 
 =head3 output
 
-An hashref of the deleted problem set or an object of type C<DBIx::Class::ResultSet::ProblemSet>
+Nothing (undef) is returned.
 
 =cut
 
 sub deleteProblemSet ($self, %args) {
-
-	my $set_to_delete = $self->getProblemSet(info => $args{info}, as_result_set => 1);
-	$set_to_delete->delete;
-
-	return $set_to_delete if $args{as_result_set};
-	my $set = { $set_to_delete->get_inflated_columns, set_type => $set_to_delete->set_type };
-	delete $set->{type};
-	return $set;
+	$self->getProblemSet(info => $args{info}, as_result_set => 1)->delete;
+	return;
 }
 
 # The following are private methods used in this module.

lib/DB/Schema/ResultSet/SetProblem.pm

@@ -157,7 +157,7 @@ if either the course or set doesn't exist, an exception will be thrown.
 
 =head3 output
 
-An array of Problems (as hashrefs) or an array of C<DBIx::Class::ResultSet::Problem>
+A problem (as a hashref) or an array of C<DBIx::Class::ResultSet::Problem>
 
 =cut
 
@@ -350,26 +350,12 @@ if either the course or set doesn't exist, an exception will be thrown.
 
 =head3 output
 
-A problem (as hashrefs) or an object of class C<DBIx::Class::ResultSet::Problem>
+Nothing (undef) is returned.
 
 =cut
 
 sub deleteSetProblem ($self, %args) {
-	my $set_problem = $self->getSetProblem(info => $args{info}, as_result_set => 1);
-	my $problem_set = $self->rs('ProblemSet')->getProblemSet(
-		info => {
-			course_id => $set_problem->problem_set->course_id,
-			set_id    => $set_problem->set_id
-		},
-		as_result_set => 1
-	);
-
-	my $problem = $problem_set->search_related('problems', getProblemInfo($args{info}))->single;
-
-	my $deleted_problem = $problem->delete;
-
-	return $deleted_problem if $args{as_result_set};
-	return { $deleted_problem->get_inflated_columns };
+	$self->getSetProblem(info => $args{info}, as_result_set => 1)->delete;
 }
 
 # just a small subroutine to shorten access to the db.

lib/DB/Schema/ResultSet/User.pm

@@ -149,11 +149,7 @@ The deleted user as a C<DBIx::Class::ResultSet::User> object.
 # TODO: Delete everything related to the user from all tables.
 
 sub deleteGlobalUser ($self, %args) {
-	my $user_to_delete = $self->getGlobalUser(info => $args{info}, as_result_set => 1);
-
-	my $deleted_user = $user_to_delete->delete;
-	return $deleted_user if $args{as_result_set};
-	return removeLoginParams({ $deleted_user->get_inflated_columns });
+	$self->getGlobalUser(info => $args{info}, as_result_set => 1)->delete;
 }
 
 =head1 updateGlobalUser
@@ -533,21 +529,18 @@ from the global user table)
 
 =over
 =item - If either information about the user or the course is missing, an exception will be thrown
-=item - If the user is already in the course, an exception will be thrown.
+=item - If the user is not in the course, an exception will be thrown.
 =back
 
 =head3 output
 
-An hashref of the deleted user or merged user or a C<DB::Schema::ResultSet::CourseUser>
+Nothing (undef) is returned.
 
 =cut
 
 sub deleteCourseUser ($self, %args) {
-	my $course_user_to_delete = $self->getCourseUser(info => $args{info}, as_result_set => 1)->delete;
-
-	return $course_user_to_delete if $args{as_result_set};
-	return $args{merged} ? _getMergedUser($course_user_to_delete) : _getCourseUser($course_user_to_delete);
-
+	$self->getCourseUser(info => $args{info}, as_result_set => 1)->delete;
+	return;
 }
 
 # This is a small subroutine to shorten access to the db.

lib/DB/Schema/ResultSet/UserProblem.pm

@@ -490,27 +490,8 @@ or a C<DBIx::Class::ResultSet::UserProblem>
 =cut
 
 sub deleteUserProblem ($self, %args) {
-	my $user_problem =
-		$args{info}->{user_problem_id}
-		? $self->find({ user_problem_id => $args{info}->{user_problem_id} })
-		: $self->getUserProblem(
-			info          => $args{info},
-			skip_throw    => 1,
-			as_result_set => 1
-		);
-
-	DB::Exception::UserProblemNotFound->throw(message => 'The user '
-			. getUserInfo($args{info})->{username} // getUserInfo($args{info})->{user_id}
-			. ' already has problem number '
-			. getProblemInfo($args{info})->{problem_number}
-			// ("(set_problem_id): " . getProblemInfo($args{info})->{set_problem_id})
-			. ' in set with name'
-			. getSetInfo($args{info})->{set_name} // ("(set_id): " . getSetInfo($args{info})->{set_id}))
-		unless $user_problem;
-
-	my $user_problem_to_delete = $user_problem->delete;
-	return $user_problem_to_delete if $args{as_result_set};
-	return $args{merged} ? _mergeUserProblem($user_problem_to_delete) : _getUserProblem($user_problem_to_delete);
+	$self->getUserProblem(info => $args{info}, as_result_set => 1)->delete;
+	return;
 }
 
 =head2 getUserProblemVersions

lib/DB/Schema/ResultSet/UserSet.pm

@@ -408,18 +408,8 @@ delete a single UserSet for a given course, user, and ProblemSet
 =cut
 
 sub deleteUserSet ($self, %args) {
-	my $user_set = $self->getUserSet(info => $args{info}, as_result_set => 1);
-
-	DB::Exception::UserSetNotInCourse->throw(
-		set_name    => $args{info}->{set_name},
-		course_name => $args{info}->{course_name},
-		username    => $args{info}->{username}
-	) unless defined($user_set);
-
-	$user_set->delete;
-	# why are we returning anything from this call? success/failure instead?
-	return $user_set if $args{as_result_set};
-	return $args{merged} ? _mergeUserSet($user_set) : _getUserSet($user_set);
+	my $user_set = $self->getUserSet(info => $args{info}, as_result_set => 1)->delete;
+	return;
 }
 
 =head2 getUserSetVersions

t/db/001_courses.t

@@ -129,10 +129,13 @@ throws_ok {
 'DB::Exception::CourseNotFound', 'updateCourse: update a non-existent course_id';
 
 # Delete a course
-my $deleted_course = $course_rs->deleteCourse(info => { course_name => 'Geometry II' });
-removeIDs($deleted_course);
+$course_rs->deleteCourse(info => { course_name => 'Geometry II' });
 
-is_deeply($new_course_params, $deleted_course, 'deleteCourse: delete a course');
+# and check that it is no longer in the database.
+throws_ok {
+	$course_rs->getCourse(info => { course_name => 'Geometry II' });
+}
+'DB::Exception::CourseNotFound', 'deleteCourse: delete a course';
 
 # Try to delete a non-existent course by name
 throws_ok {

t/db/003_users.t

@@ -222,26 +222,20 @@ throws_ok {
 qr/No such column 'invalid_field'/, 'updateUser: pass in an invalid field';
 
 # Delete users that were created
-my $user_to_delete = $users_rs->deleteGlobalUser(info => { username => $user->{username} });
-
-removeIDs($user_to_delete);
-cleanUndef($user_to_delete);
-is_deeply($updated_user, $user_to_delete, 'deleteUser: delete a user');
-
-my $deleted_selma = $users_rs->deleteGlobalUser(info => { username => 'selma' });
-removeIDs($deleted_selma);
-cleanUndef($deleted_selma);
-is_deeply($deleted_selma, $selma_params, 'deleteUser: deleter another user');
-
-my $deleted_patty = $users_rs->deleteGlobalUser(info => { username => 'patty' });
-removeIDs($deleted_patty);
-cleanUndef($deleted_patty);
-is_deeply($deleted_patty, $patty_params, 'deleteUser: deleter a third user');
-
-my $user_to_delete2 = $users_rs->deleteGlobalUser(info => { username => $added_user2->{username} });
-removeIDs($user_to_delete2);
-cleanUndef($user_to_delete2);
-is_deeply($added_user2, $user_to_delete2, 'deleteUser: delete yet another user.');
+$users_rs->deleteGlobalUser(info => { username => $user->{username} });
+
+# and check they are no longer in the database:
+throws_ok {
+	$users_rs->getGlobalUser(info => { username => $user->{username}});
+}
+'DB::Exception::UserNotFound', 'deleteUser: delete a user';
+
+# Delete others and no need to check because a full check to see that the database
+# is restored is done below.
+
+$users_rs->deleteGlobalUser(info => { username => 'selma' });
+$users_rs->deleteGlobalUser(info => { username => 'patty' });
+$users_rs->deleteGlobalUser(info => { username => $added_user2->{username} });
 
 # Delete a user that doesn't exist.
 throws_ok {

t/db/004_course_users.t

@@ -328,41 +328,39 @@ throws_ok {
 }
 'DB::Exception::InvalidParameter', 'updateCourseUser: an parameter with invalid value';
 
-# Delete a single user from a course.
-my $deleted_user;
-my $dont_delete_users;    # Switch to not delete added users.
+# Delete a course user
+$user_rs->deleteCourseUser(info => { course_name => 'Arithmetic', username => 'quimby' });
 
-SKIP: {
-	skip 'delete added users', 5 if $dont_delete_users;
-
-	my $deleted_course_user = $user_rs->deleteCourseUser(info => { course_name => 'Arithmetic', username => 'quimby' });
-	removeIDs($deleted_course_user);
-
-	is_deeply($course_user_params, $deleted_course_user, 'deleteCourseUser: delete a user from a course');
+# and check to ensure quimby was deleted.
+throws_ok {
+	$user_rs->getCourseUser(info => { course_name => 'Arithmetic', username => 'quimby' });
+}
+'DB::Exception::UserNotInCourse', 'deleteCourseUser: delete a user from a course';
 
-	$deleted_user = $user_rs->deleteGlobalUser(info => { username => 'quimby' });
-	removeIDs($deleted_user);
+$user_rs->deleteGlobalUser(info => { username => 'quimby' });
 
-	is_deeply($user_params, $deleted_user, 'deleteGlobalUser: delete a user');
+throws_ok {
+	$user_rs->getGlobalUser(info => { username => 'quimby' });
+}
+'DB::Exception::UserNotFound', 'deleteGlobalUser: delete a user';
 
-	# deleteUser: Check that if the course doesn't exist, an error is thrown:
-	throws_ok {
-		$user_rs->deleteCourseUser(info => { course_name => 'unknown_course', username => 'barney' });
-	}
-	'DB::Exception::CourseNotFound', "deleteUser: the course doesn't exist";
+# deleteUser: Check that if the course doesn't exist, an error is thrown:
+throws_ok {
+	$user_rs->deleteCourseUser(info => { course_name => 'unknown_course', username => 'barney' });
+}
+'DB::Exception::CourseNotFound', "deleteUser: the course doesn't exist";
 
-	# deleteUser: Check that if the course exists, but the user not a member.
-	throws_ok {
-		$user_rs->deleteCourseUser(info => { course_name => 'Arithmetic', username => 'marge' });
-	}
-	'DB::Exception::UserNotInCourse', 'deleteUser: the user is not a member of the course';
+# deleteUser: Check that if the course exists, but the user not a member.
+throws_ok {
+	$user_rs->deleteCourseUser(info => { course_name => 'Arithmetic', username => 'marge' });
+}
+'DB::Exception::UserNotInCourse', 'deleteUser: the user is not a member of the course';
 
-	# deleteUser: Send in username_name instead of username
-	throws_ok {
-		$user_rs->deleteCourseUser(info => { course_name => 'Arithmetic', username_name => 'bart' });
-	}
-	'DB::Exception::ParametersNeeded', 'deleteUser: the incorrect information is passed in.';
+# deleteUser: Send in username_name instead of username
+throws_ok {
+	$user_rs->deleteCourseUser(info => { course_name => 'Arithmetic', username_name => 'bart' });
 }
+'DB::Exception::ParametersNeeded', 'deleteUser: the incorrect information is passed in.';
 
 # Check that the precalc users have not changed.
 @precalc_users_from_db = $user_rs->getCourseUsers(info => { course_name => 'Precalculus' }, merged => 1);