Add @Wikibase::Datatype::Utils::LANGUAGE_CODES variable to define user language codes list

Author: michal-josef-spacek

Changes

@@ -3,6 +3,8 @@
  - Add 'ak' language code used in Q111803082.
  - Add $Wikibase::Datatype::Utils::SKIP_CHECK_LANG variable to skip check of
    Wikibase languages which are supported.
+ - Add @Wikibase::Datatype::Utils::LANGUAGE_CODES variable to define user
+   language codes list.
  - Remove obsolete error message in doc for check_language() helper.
 
 0.36 2025-01-01T22:02:29+01:00

lib/Wikibase/Datatype/Utils.pm

@@ -14,6 +14,7 @@ Readonly::Array our @EXPORT_OK => qw(check_datetime check_entity check_language
 	check_lexeme check_property check_sense);
 
 our $SKIP_CHECK_LANG => 0;
+our @LANGUAGE_CODES => ();
 
 our $VERSION = 0.37;
 
@@ -79,8 +80,19 @@ sub check_entity {
 sub check_language {
 	my ($self, $key) = @_;
 
-	if (! $SKIP_CHECK_LANG && none { $_ eq $self->{$key} } all_language_codes()) {
-		err "Language code '".$self->{$key}."' isn't code supported by Wikibase.";
+	if (! $SKIP_CHECK_LANG) {
+		my @language_codes;
+		my $error_message;
+		if (@LANGUAGE_CODES) {
+			@language_codes = @LANGUAGE_CODES;
+			$error_message = "Language code '".$self->{$key}."' isn't user defined language code.";
+		} else {
+			@language_codes = all_language_codes();
+			$error_message = "Language code '".$self->{$key}."' isn't code supported by Wikibase.";
+		}
+		if (none { $_ eq $self->{$key} } @language_codes) {
+			err $error_message;
+		}
 	}
 
 	return;
@@ -165,6 +177,12 @@ Boolean variable to skip check of right language.
 
 Default value is 0, checking is working.
 
+=head2 C<@LANGUAGE_CODES>
+
+List of supported language codes defined by user.
+
+Default value is (), checking official language codes.
+
 =head1 SUBROUTINES
 
 =head2 C<check_datetime>

t/Wikibase-Datatype-Utils/05-check_language.t

@@ -3,7 +3,7 @@ use warnings;
 
 use English;
 use Error::Pure::Utils qw(clean);
-use Test::More 'tests' => 5;
+use Test::More 'tests' => 8;
 use Test::NoWarnings;
 use Wikibase::Datatype::Utils qw(check_language);
 
@@ -43,3 +43,34 @@ $self = {
 $Wikibase::Datatype::Utils::SKIP_CHECK_LANG = 1;
 $ret = check_language($self, 'key');
 is($ret, undef, 'Not supported language is present without error.');
+
+# Test.
+$self = {
+	'key' => 'xx',
+};
+$Wikibase::Datatype::Utils::SKIP_CHECK_LANG = 0;
+@Wikibase::Datatype::Utils::LANGUAGE_CODES = ('xx');
+$ret = check_language($self, 'key');
+is($ret, undef, 'Language is supported by user list.');
+
+# Test.
+$self = {
+	'key' => 'yy',
+};
+$Wikibase::Datatype::Utils::SKIP_CHECK_LANG = 0;
+@Wikibase::Datatype::Utils::LANGUAGE_CODES = ('xx');
+eval {
+	check_language($self, 'key');
+};
+is($EVAL_ERROR, "Language code 'yy' isn't user defined language code.\n",
+	"Language code 'yy' isn't user defined language code.");
+clean();
+
+# Test.
+$self = {
+	'key' => 'yy',
+};
+$Wikibase::Datatype::Utils::SKIP_CHECK_LANG = 1;
+@Wikibase::Datatype::Utils::LANGUAGE_CODES = ('xx');
+$ret = check_language($self, 'key');
+is($ret, undef, 'Not supported language is present without error.');

t/Wikibase-Datatype-Value-Monolingual/03-new.t

@@ -3,7 +3,7 @@ use warnings;
 
 use English;
 use Error::Pure::Utils qw(clean);
-use Test::More 'tests' => 7;
+use Test::More 'tests' => 10;
 use Test::NoWarnings;
 use Unicode::UTF8 qw(decode_utf8);
 use Wikibase::Datatype::Value::Monolingual;
@@ -56,3 +56,33 @@ $obj = Wikibase::Datatype::Value::Monolingual->new(
 	'value' => 'foo',
 );
 isa_ok($obj, 'Wikibase::Datatype::Value::Monolingual');
+
+# Test.
+$Wikibase::Datatype::Utils::SKIP_CHECK_LANG = 0;
+@Wikibase::Datatype::Utils::LANGUAGE_CODES = ('ger');
+$obj = Wikibase::Datatype::Value::Monolingual->new(
+	'language' => 'ger',
+	'value' => 'foo',
+);
+isa_ok($obj, 'Wikibase::Datatype::Value::Monolingual');
+
+# Test.
+$Wikibase::Datatype::Utils::SKIP_CHECK_LANG = 0;
+@Wikibase::Datatype::Utils::LANGUAGE_CODES = ('yy');
+eval {
+	Wikibase::Datatype::Value::Monolingual->new(
+		'language' => 'ger',
+		'value' => 'foo',
+	);
+};
+is($EVAL_ERROR, "Language code 'ger' isn't user defined language code.\n",
+	"Language code 'ger' isn't user defined language code.");
+
+# Test.
+$Wikibase::Datatype::Utils::SKIP_CHECK_LANG = 1;
+@Wikibase::Datatype::Utils::LANGUAGE_CODES = ('yy');
+$obj = Wikibase::Datatype::Value::Monolingual->new(
+	'language' => 'ger',
+	'value' => 'foo',
+);
+isa_ok($obj, 'Wikibase::Datatype::Value::Monolingual');