WIP: initial checkin of some changes to handling settings.

WIP: work on course_settings

WIP: continued work on the course settings

WIP: continued work on course_settings.

TEST: mojolicious route testing for settings.

WIP: continued work on course settings

Author: pstaabp

conf/course_defaults.yml conf/course_settings.ymlconf/course_defaults.yml renamed to conf/course_settings.yml

@@ -18,6 +18,10 @@ use Exception::Class (
 		fields      => ['message'],
 		description => 'There is an invalid field type'
 	},
+	'DB::Expection::SettingNotFound' => {
+		fields      => ['name'],
+		description => 'A global setting is not found'
+	},
 	'DB::Exception::UndefinedParameter' => {
 		fields      => ['field_names'],
 		description => 'There is an undefined parameter'

lib/DB/Exception.pm

@@ -80,7 +80,7 @@ __PACKAGE__->has_many(problem_sets => 'DB::Schema::Result::ProblemSet', 'course_
 # set up the one-to-many relationship to problem_pools
 __PACKAGE__->has_many(problem_pools => 'DB::Schema::Result::ProblemPool', 'course_id');
 
-# set up the one-to-one relationship to course settings;
-__PACKAGE__->has_one(course_settings => 'DB::Schema::Result::CourseSettings', 'course_id');
+# set up the one-to-many relationship to course settings;
+__PACKAGE__->has_many(course_settings => 'DB::Schema::Result::CourseSetting', 'course_id');
 
 1;

lib/DB/Schema/Result/Course.pm

@@ -0,0 +1,67 @@
+package DB::Schema::Result::CourseSetting;
+use base qw/DBIx::Class::Core/;
+use strict;
+use warnings;
+
+=head1 DESCRIPTION
+
+This is the database schema for a CourseSetting.
+
+=head2 fields
+
+=over
+
+=item *
+
+C<course_setting_id>: database id (autoincrement integer)
+
+=item *
+
+C<course_id>: database id of the course for the setting (foreign key)
+
+=item *
+
+C<setting_id>: database id that the given setting is related to (foreign key)
+
+=item *
+
+C<value>: the value of the setting
+
+=back
+
+=cut
+
+__PACKAGE__->table('course_setting');
+
+__PACKAGE__->add_columns(
+	course_setting_id => {
+		data_type         => 'integer',
+		size              => 16,
+		is_nullable       => 0,
+		is_auto_increment => 1,
+	},
+	course_id => {
+		data_type   => 'integer',
+		size        => 16,
+		is_nullable => 0,
+	},
+	setting_id => {
+		data_type   => 'integer',
+		size        => 16,
+		is_nullable => 0,
+	},
+	value => {
+		data_type   => 'text',
+		is_nullable => 0,
+	},
+);
+
+__PACKAGE__->set_primary_key('course_setting_id');
+
+__PACKAGE__->add_unique_constraint([qw/course_id setting_id/]);
+
+__PACKAGE__->belongs_to(course => 'DB::Schema::Result::Course', 'course_id');
+
+__PACKAGE__->belongs_to(global_setting => 'DB::Schema::Result::GlobalSetting', 'setting_id');
+
+1;

lib/DB/Schema/Result/CourseSetting.pm

@@ -0,0 +1,117 @@
+package DB::Schema::Result::GlobalSetting;
+use base qw/DBIx::Class::Core/;
+use strict;
+use warnings;
+
+=head1 DESCRIPTION
+
+This is the database schema for the Global Course Settings.
+
+=head2 fields
+
+=over
+
+=item *
+
+C<setting_id>: database id (autoincrement integer)
+
+=item *
+
+C<setting_name>: the name of the setting
+
+=item *
+
+C<default_value>: a JSON object of the default value for the setting
+
+=item *
+
+C<description>: a short description of the setting
+
+=item *
+
+C<doc>: more extensive help documentation.
+
+=item *
+
+C<type>: a string representation of the type of setting (boolean, text, list, ...)
+
+=item *
+
+C<options>: a JSON object that stores options if the setting is an list or multilist
+
+=item *
+
+C<category>: the category the setting falls into
+
+=item *
+
+C<subcategory>: the subcategory of the setting (may be null)
+
+=back
+
+=cut
+
+__PACKAGE__->table('global_setting');
+
+__PACKAGE__->load_components('InflateColumn::Serializer', 'Core');
+
+__PACKAGE__->add_columns(
+	setting_id => {
+		data_type         => 'integer',
+		size              => 16,
+		is_nullable       => 0,
+		is_auto_increment => 1,
+	},
+	setting_name => {
+		data_type   => 'varchar',
+		size        => 256,
+		is_nullable => 0,
+	},
+	default_value => {
+		data_type          => 'text',
+		is_nullable        => 0,
+		default_value      => '\'\'',
+		serializer_class   => 'JSON',
+		serializer_options => { utf8 => 1 }
+	},
+	description => {
+		data_type     => 'text',
+		is_nullable   => 0,
+		default_value => '',
+	},
+	doc => {
+		data_type     => 'text',
+		is_nullable   => 1,
+	},
+	type => {
+		data_type     => 'varchar',
+		size          => 16,
+		is_nullable   => 0,
+		default_value => '',
+	},
+	options => {
+		data_type          => 'text',
+		is_nullable        => 1,
+		serializer_class   => 'JSON',
+		serializer_options => { utf8 => 1 }
+	},
+	category => {
+		data_type     => 'varchar',
+		size          => 64,
+		is_nullable   => 0,
+		default_value => ''
+	},
+	subcategory => {
+		data_type     => 'varchar',
+		size          => 64,
+		is_nullable   => 1
+	}
+);
+
+__PACKAGE__->set_primary_key('setting_id');
+
+__PACKAGE__->has_many(course_settings => 'DB::Schema::Result::CourseSetting', 'setting_id');
+
+# __PACKAGE__->belongs_to(course => 'DB::Schema::Result::Course', 'course_id');
+
+1;