Switch to using perl signatures in all of the lib files. Note that all

sub's should have a signature, even those that take no parameters.  This
ensures that methods are called with the correct parameters.

Remove double hashed comments except those for perl critic which is the
only place where double hashed comments should be used.

Full sentence comments should also always be capatilized and properly
punctuated.

.perlcriticrc

@@ -1,3 +1,7 @@
 severity = 4
 
 [-Subroutines::ProhibitSubroutinePrototypes]
+
+# Allow no warnings usage with a category restriction (for signatures)
+[TestingAndDebugging::ProhibitNoWarnings]
+allow_with_category_restriction = 1

lib/DB/General.pm

@@ -7,33 +7,6 @@ use warnings;
 The class DB::Schema::ResultSet::General pull the common functionality for
 the other classes in the schema resultsets include
 
-=over
-
-=item Course
-
-=item User
-
-=item ProblemSet
-
-=item UserSet
-
-=item Problem
-
-=back
-
 =cut
 
-use Carp;
-use Data::Dump qw/dd dump/;
-use List::Util qw/first/;
-
-use Clone qw/clone/;
-use DB::Utils qw/getCourseInfo getUserInfo/;
-use DB::Exception;
-use Exception::Class ('DB::Exception::CourseNotFound', 'DB::Exception::CourseExists');
-
-use DB::TestUtils qw/removeIDs/;
-use WeBWorK3::Utils::Settings qw/getDefaultCourseSettings mergeCourseSettings
-	getDefaultCourseValues validateCourseSettings/;
-
 1;

lib/DB/Schema.pm

@@ -1,6 +1,6 @@
 package DB::Schema;
 
-## This is the base package for the Schema for the WeBWorK.
+# This is the base package for the Schema for the WeBWorK.
 
 use warnings;
 use strict;

lib/DB/Schema/Result/CourseUser.pm

@@ -131,7 +131,8 @@ __PACKAGE__->add_columns(
 		size        => 16,
 		is_nullable => 1,
 	},
-	params => {    # store params as a JSON object
+	# Store params as a JSON object.
+	params => {
 		data_type          => 'text',
 		size               => 256,
 		is_nullable        => 0,

lib/DB/Schema/Result/PoolProblem.pm

@@ -1,7 +1,10 @@
 package DB::Schema::Result::PoolProblem;
 use base qw/DBIx::Class::Core/;
+
 use strict;
 use warnings;
+use feature 'signatures';
+no warnings 'experimental::signatures';
 
 =head1 DESCRIPTION
 
@@ -69,14 +72,14 @@ __PACKAGE__->add_columns(
 	}
 );
 
-sub valid_params {
+sub valid_params () {
 	return {
 		library_id   => q{\d+},
 		problem_path => q{((\w)+\/?)+}
 	};
 }
 
-sub required_params {
+sub required_params () {
 	return { '_ONE_OF_' => [ 'library_id', 'problem_path' ] };
 }
 

lib/DB/Schema/Result/Problem.pm

@@ -4,6 +4,8 @@ use DB::WithParams;
 
 use strict;
 use warnings;
+use feature 'signatures';
+no warnings qw(experimental::signatures);
 
 use base qw(DBIx::Class::Core DB::WithParams);
 
@@ -60,7 +62,7 @@ Note: a problem should have only one of a library_id, problem_path or problem_po
 
 =cut
 
-sub valid_params {
+sub valid_params () {
 	return {
 		weight          => q{^[+]?([0-9]+(?:[\.][0-9]*)?|\.[0-9]+)$},    # positive integers or decimals
 		library_id      => q{\d+},
@@ -69,11 +71,11 @@ sub valid_params {
 	};
 }
 
-sub required_params {
+sub required_params () {
 	return { '_ALL_' => [ 'weight', { '_ONE_OF_' => [ 'library_id', 'file_path', 'problem_pool_id' ] } ] };
 }
 
-### this is the table that stores problems for a given Problem Set
+# This is the table that stores problems for a given Problem Set.
 
 __PACKAGE__->table('problem');
 
@@ -102,7 +104,8 @@ __PACKAGE__->add_columns(
 		is_nullable   => 0,
 		default_value => 1
 	},
-	problem_params => {    # store params as a JSON object
+	# Store params as a JSON object.
+	problem_params => {
 		data_type          => 'text',
 		size               => 256,
 		is_nullable        => 0,
@@ -114,7 +117,7 @@ __PACKAGE__->add_columns(
 
 __PACKAGE__->set_primary_key('problem_id');
 
-# maybe we don't need this.
+# Maybe we don't need this.
 __PACKAGE__->add_unique_constraint([qw/problem_id set_id problem_version problem_number/]);
 
 __PACKAGE__->belongs_to(problem_set => 'DB::Schema::Result::ProblemSet', 'set_id');

lib/DB/Schema/Result/ProblemSet.pm

@@ -3,6 +3,8 @@ use base qw/DBIx::Class::Core/;
 
 use strict;
 use warnings;
+use feature 'signatures';
+no warnings qw(experimental::signatures);
 
 =head1 DESCRIPTION
 
@@ -100,7 +102,7 @@ __PACKAGE__->add_columns(
 		default_value => 1,
 		is_nullable   => 0
 	},
-	# store dates as a JSON object
+	# Store dates as a JSON object.
 	set_dates => {
 		data_type          => 'text',
 		size               => 256,
@@ -109,7 +111,7 @@ __PACKAGE__->add_columns(
 		serializer_class   => 'JSON',
 		serializer_options => { utf8 => 1 }
 	},
-	# store params as a JSON object
+	# Store params as a JSON object.
 	set_params => {
 		data_type          => 'text',
 		size               => 256,
@@ -120,9 +122,7 @@ __PACKAGE__->add_columns(
 	}
 );
 
-#
 # This defines the non-abstract classes of ProblemSets.
-#
 
 __PACKAGE__->typecast_map(
 	type => {
@@ -146,8 +146,8 @@ returns the type (HW, Quiz, JITAR, REVIEW) of the problem set
 
 =cut
 
-sub set_type {
+sub set_type ($set) {
 	my %set_type_rev = reverse %{$DB::Schema::ResultSet::ProblemSet::SET_TYPES};
-	return $set_type_rev{ shift->type };
+	return $set_type_rev{ $set->type };
 }
 1;

lib/DB/Schema/Result/ProblemSet/HWSet.pm

@@ -2,6 +2,9 @@ package DB::Schema::Result::ProblemSet::HWSet;
 
 use strict;
 use warnings;
+use feature 'signatures';
+no warnings qw(experimental::signatures);
+
 use base qw(DB::Schema::Result::ProblemSet DB::WithParams DB::WithDates);
 
 =head1 DESCRIPTION
@@ -20,7 +23,7 @@ subroutine that returns the array for the valid dates: C<['open', 'reduced_scori
 
 =cut
 
-sub valid_dates {
+sub valid_dates () {
 	return [ 'open', 'reduced_scoring', 'due', 'answer' ];
 }
 
@@ -30,7 +33,7 @@ subroutine that returns the array for the required dates: C<['open', 'due' ,'ans
 
 =cut
 
-sub required_dates {
+sub required_dates () {
 	return [ 'open', 'due', 'answer' ];
 }
 
@@ -74,7 +77,7 @@ This is a description of the homework set.
 
 =cut
 
-sub valid_params {
+sub valid_params () {
 	return {
 		enable_reduced_scoring => q{[01]},
 		hide_hint              => q{[01]},
@@ -90,7 +93,7 @@ No parameters are required for the homework set.
 
 =cut
 
-sub required_params {
+sub required_params () {
 	return {};
 }
 

lib/DB/Schema/Result/ProblemSet/Quiz.pm

@@ -2,6 +2,9 @@ package DB::Schema::Result::ProblemSet::Quiz;
 
 use strict;
 use warnings;
+use feature 'signatures';
+no warnings qw(experimental::signatures);
+
 use base qw(DB::Schema::Result::ProblemSet DB::WithParams DB::WithDates);
 
 =head1 DESCRIPTION
@@ -20,7 +23,7 @@ subroutine that returns the array for the valid dates: C<['open', 'due' ,'answer
 
 =cut
 
-sub valid_dates {
+sub valid_dates () {
 	return [ 'open', 'due', 'answer' ];
 }
 
@@ -30,7 +33,7 @@ subroutine that returns the array for the required dates: C<['open', 'due' ,'ans
 
 =cut
 
-sub required_dates {
+sub required_dates () {
 	return [ 'open', 'due', 'answer' ];
 }
 
@@ -56,7 +59,7 @@ if the quiz is timed, how long should it be open.
 
 =cut
 
-sub valid_params {
+sub valid_params () {
 	return {
 		timed         => q{^[01]$},
 		quiz_duration => q{\d+},
@@ -69,7 +72,7 @@ No parameters are required for the homework set.
 
 =cut
 
-sub required_params {
+sub required_params () {
 	return {};
 }
 

lib/DB/Schema/Result/ProblemSet/ReviewSet.pm

@@ -1,7 +1,10 @@
 package DB::Schema::Result::ProblemSet::ReviewSet;
 use base qw(DB::Schema::Result::ProblemSet DB::WithDates DB::WithParams);
+
 use strict;
 use warnings;
+use feature 'signatures';
+no warnings qw(experimental::signatures);
 
 =head1 DESCRIPTION
 
@@ -19,7 +22,7 @@ subroutine that returns the array for the valid dates: C<['open', 'closed']>
 
 =cut
 
-sub valid_dates {
+sub valid_dates () {
 	return [ 'open', 'closed' ];
 }
 
@@ -29,7 +32,7 @@ subroutine that returns the array for the required dates: C<['open', 'closed']>
 
 =cut
 
-sub required_dates {
+sub required_dates () {
 	return [ 'open', 'closed' ];
 }
 
@@ -39,7 +42,7 @@ subroutine that returns the hashref for the valid parameters:  (currently empty)
 
 =cut
 
-sub valid_params {
+sub valid_params () {
 	return {};
 }
 
@@ -49,7 +52,7 @@ subroutine that returns the hashref for the required parameters:  (currently emp
 
 =cut
 
-sub required_params {
+sub required_params () {
 	return {};
 }
 

lib/DB/Schema/Result/UserProblem.pm

@@ -3,13 +3,10 @@ use base qw/DBIx::Class::Core/;
 use strict;
 use warnings;
 
-### this is the table that stores problems for a given Problem Set
-
-## Note: we probably also need to store the problem info if it changes.
-
-# perhaps the params will store both the problem info and the seed.
-
-# don't allow the same problem/seed.
+# This is the table that stores problems for a given Problem Set.
+# Note: we probably also need to store the problem info if it changes.
+# Perhaps the params will store both the problem info and the seed.
+# Don't allow the same problem/seed.
 
 __PACKAGE__->table('user_problem');