/usr/share/perl5/DBIx/Class/Schema/Loader/Optional/Dependencies.pm is in libdbix-class-schema-loader-perl 0.07048-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 | package DBIx::Class::Schema::Loader::Optional::Dependencies;
### This may look crazy, but it in fact tangibly ( by 50(!)% ) shortens
# the skip-test time when everything requested is unavailable
BEGIN {
if ( $ENV{RELEASE_TESTING} ) {
require warnings and warnings->import;
require strict and strict->import;
}
}
sub croak {
require Carp;
Carp::croak(@_);
};
###
# NO EXTERNAL NON-5.8.1 CORE DEPENDENCIES EVER (e.g. C::A::G)
# This module is to be loaded by Makefile.PM on a pristine system
# POD is generated automatically by calling _gen_pod from the
# Makefile.PL in $AUTHOR mode
my $dbic_reqs = {
use_moose => {
req => {
'Moose' => '1.12',
'MooseX::NonMoose' => '0.25',
'namespace::autoclean' => '0.09',
'MooseX::MarkAsMethods' => '0.13',
},
pod => {
title => 'use_moose',
desc => 'Modules required for the use_moose option',
},
},
dbicdump_config => {
req => {
'Config::Any' => '0',
},
pod => {
title => 'dbicdump config file',
desc => 'Modules required for using a config file with dbicdump',
},
},
test_dbicdump_config => {
include => 'dbicdump_config',
req => {
'Config::General' => '0',
},
pod => {
title => 'dbicdump config file testing',
desc => 'Modules required for using testing using a config file with dbicdump',
},
},
_rdbms_generic_odbc => {
req => {
'DBD::ODBC' => 0,
}
},
_rdbms_generic_ado => {
req => {
'DBD::ADO' => 0,
}
},
# must list any dep used by adhoc testing
# this prevents the "skips due to forgotten deps" issue
test_adhoc => {
req => {
},
},
id_shortener => {
req => {
'Math::BigInt' => '1.80',
'Math::Base36' => '0.07',
},
},
test_pod => {
req => {
'Test::Pod' => '1.14',
'Pod::Simple' => '3.22',
},
pod => {
title => 'POD testing',
desc => 'Modules required for testing POD in this distribution',
},
release_testing_mandatory => 1,
},
test_podcoverage => {
req => {
'Test::Pod::Coverage' => '1.08',
'Pod::Coverage' => '0.20',
},
release_testing_mandatory => 1,
},
test_whitespace => {
req => {
'Test::EOL' => '1.0',
'Test::NoTabs' => '0.9',
},
release_testing_mandatory => 1,
},
test_strictures => {
req => {
'Test::Strict' => '0.20',
},
release_testing_mandatory => 1,
},
test_backcompat => {
env => [
SCHEMA_LOADER_TESTS_BACKCOMPAT => 1,
],
},
# this is just for completeness as SQLite
# is a core dep of DBIC for testing
rdbms_sqlite => {
req => {
'DBD::SQLite' => 0,
},
pod => {
title => 'SQLite support',
desc => 'Modules required to connect to SQLite',
},
augment => {
},
},
rdbms_pg => {
req => {
# when changing this list make sure to adjust xt/optional_deps.t
'DBD::Pg' => 0,
},
pod => {
title => 'PostgreSQL support',
desc => 'Modules required to connect to PostgreSQL',
},
},
_rdbms_mssql_common => {
},
rdbms_mssql_odbc => {
include => [qw( _rdbms_generic_odbc _rdbms_mssql_common )],
pod => {
title => 'MSSQL support via DBD::ODBC',
desc => 'Modules required to connect to MSSQL via DBD::ODBC',
},
},
rdbms_mssql_sybase => {
include => '_rdbms_mssql_common',
req => {
'DBD::Sybase' => 0,
},
pod => {
title => 'MSSQL support via DBD::Sybase',
desc => 'Modules required to connect to MSSQL via DBD::Sybase',
},
},
rdbms_mssql_ado => {
include => [qw( _rdbms_generic_ado _rdbms_mssql_common )],
pod => {
title => 'MSSQL support via DBD::ADO (Windows only)',
desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
},
},
_rdbms_msaccess_common => {
},
rdbms_msaccess_odbc => {
include => [qw( _rdbms_generic_odbc _rdbms_msaccess_common )],
pod => {
title => 'MS Access support via DBD::ODBC',
desc => 'Modules required to connect to MS Access via DBD::ODBC',
},
},
rdbms_msaccess_ado => {
include => [qw( _rdbms_generic_ado _rdbms_msaccess_common )],
pod => {
title => 'MS Access support via DBD::ADO (Windows only)',
desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
},
},
rdbms_mysql => {
req => {
'DBD::mysql' => 0,
},
pod => {
title => 'MySQL support',
desc => 'Modules required to connect to MySQL',
},
},
rdbms_oracle => {
include => 'id_shortener',
req => {
'DBD::Oracle' => 0,
},
pod => {
title => 'Oracle support',
desc => 'Modules required to connect to Oracle',
},
augment => {
},
},
rdbms_ase => {
req => {
'DBD::Sybase' => 0,
},
pod => {
title => 'Sybase ASE support',
desc => 'Modules required to connect to Sybase ASE',
},
},
rdbms_db2 => {
req => {
'DBD::DB2' => 0,
},
pod => {
title => 'DB2 support',
desc => 'Modules required to connect to DB2',
},
},
rdbms_informix => {
req => {
'DBD::Informix' => 0,
},
pod => {
title => 'Informix support',
desc => 'Modules required to connect to Informix',
},
},
_rdbms_sqlanywhere_common => {
},
rdbms_sqlanywhere => {
include => '_rdbms_sqlanywhere_common',
req => {
'DBD::SQLAnywhere' => 0,
},
pod => {
title => 'SQLAnywhere support',
desc => 'Modules required to connect to SQLAnywhere',
},
},
rdbms_sqlanywhere_odbc => {
include => [qw( _rdbms_generic_odbc _rdbms_sqlanywhere_common )],
pod => {
title => 'SQLAnywhere support via DBD::ODBC',
desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
},
},
_rdbms_firebird_common => {
},
rdbms_firebird => {
include => '_rdbms_firebird_common',
req => {
'DBD::Firebird' => 0,
},
pod => {
title => 'Firebird support',
desc => 'Modules required to connect to Firebird',
},
},
rdbms_firebird_interbase => {
include => '_rdbms_firebird_common',
req => {
'DBD::InterBase' => 0,
},
pod => {
title => 'Firebird support via DBD::InterBase',
desc => 'Modules required to connect to Firebird via DBD::InterBase',
},
},
rdbms_firebird_odbc => {
include => [qw( _rdbms_generic_odbc _rdbms_firebird_common )],
pod => {
title => 'Firebird support via DBD::ODBC',
desc => 'Modules required to connect to Firebird via DBD::ODBC',
},
},
test_rdbms_sqlite => {
include => 'rdbms_sqlite',
req => {
###
### IMPORTANT - do not raise this dependency
### even though many bugfixes are present in newer versions, the general DBIC
### rule is to bend over backwards for available DBDs (given upgrading them is
### often *not* easy or even possible)
###
'DBD::SQLite' => '1.29',
},
},
test_rdbms_pg => {
include => 'rdbms_pg',
env => [
DBICTEST_PG_DSN => 1,
DBICTEST_PG_USER => 0,
DBICTEST_PG_PASS => 0,
],
req => {
# the order does matter because the rdbms support group might require
# a different version that the test group
#
# when changing this list make sure to adjust xt/optional_deps.t
'DBD::Pg' => '2.009002', # specific version to test bytea
},
},
test_rdbms_mssql_odbc => {
include => 'rdbms_mssql_odbc',
env => [
DBICTEST_MSSQL_ODBC_DSN => 1,
DBICTEST_MSSQL_ODBC_USER => 0,
DBICTEST_MSSQL_ODBC_PASS => 0,
],
},
test_rdbms_mssql_ado => {
include => 'rdbms_mssql_ado',
env => [
DBICTEST_MSSQL_ADO_DSN => 1,
DBICTEST_MSSQL_ADO_USER => 0,
DBICTEST_MSSQL_ADO_PASS => 0,
],
},
test_rdbms_mssql_sybase => {
include => 'rdbms_mssql_sybase',
env => [
DBICTEST_MSSQL_DSN => 1,
DBICTEST_MSSQL_USER => 0,
DBICTEST_MSSQL_PASS => 0,
],
},
test_rdbms_msaccess_odbc => {
include => 'rdbms_msaccess_odbc',
env => [
DBICTEST_MSACCESS_ODBC_DSN => 1,
DBICTEST_MSACCESS_ODBC_USER => 0,
DBICTEST_MSACCESS_ODBC_PASS => 0,
],
req => {
'Data::GUID' => '0',
},
},
test_rdbms_msaccess_ado => {
include => 'rdbms_msaccess_ado',
env => [
DBICTEST_MSACCESS_ADO_DSN => 1,
DBICTEST_MSACCESS_ADO_USER => 0,
DBICTEST_MSACCESS_ADO_PASS => 0,
],
req => {
'Data::GUID' => 0,
},
},
test_rdbms_mysql => {
include => 'rdbms_mysql',
env => [
DBICTEST_MYSQL_DSN => 1,
DBICTEST_MYSQL_USER => 0,
DBICTEST_MYSQL_PASS => 0,
],
},
test_rdbms_oracle => {
include => 'rdbms_oracle',
env => [
DBICTEST_ORA_DSN => 1,
DBICTEST_ORA_USER => 0,
DBICTEST_ORA_PASS => 0,
],
req => {
'DBD::Oracle' => '1.24',
},
},
test_rdbms_ase => {
include => 'rdbms_ase',
env => [
DBICTEST_SYBASE_DSN => 1,
DBICTEST_SYBASE_USER => 0,
DBICTEST_SYBASE_PASS => 0,
],
},
test_rdbms_db2 => {
include => 'rdbms_db2',
env => [
DBICTEST_DB2_DSN => 1,
DBICTEST_DB2_USER => 0,
DBICTEST_DB2_PASS => 0,
],
},
test_rdbms_informix => {
include => 'rdbms_informix',
env => [
DBICTEST_INFORMIX_DSN => 1,
DBICTEST_INFORMIX_USER => 0,
DBICTEST_INFORMIX_PASS => 0,
],
},
test_rdbms_sqlanywhere => {
include => 'rdbms_sqlanywhere',
env => [
DBICTEST_SQLANYWHERE_DSN => 1,
DBICTEST_SQLANYWHERE_USER => 0,
DBICTEST_SQLANYWHERE_PASS => 0,
],
},
test_rdbms_sqlanywhere_odbc => {
include => 'rdbms_sqlanywhere_odbc',
env => [
DBICTEST_SQLANYWHERE_ODBC_DSN => 1,
DBICTEST_SQLANYWHERE_ODBC_USER => 0,
DBICTEST_SQLANYWHERE_ODBC_PASS => 0,
],
},
test_rdbms_firebird => {
include => 'rdbms_firebird',
env => [
DBICTEST_FIREBIRD_DSN => 1,
DBICTEST_FIREBIRD_USER => 0,
DBICTEST_FIREBIRD_PASS => 0,
],
},
test_rdbms_firebird_interbase => {
include => 'rdbms_firebird_interbase',
env => [
DBICTEST_FIREBIRD_INTERBASE_DSN => 1,
DBICTEST_FIREBIRD_INTERBASE_USER => 0,
DBICTEST_FIREBIRD_INTERBASE_PASS => 0,
],
},
test_rdbms_firebird_odbc => {
include => 'rdbms_firebird_odbc',
env => [
DBICTEST_FIREBIRD_ODBC_DSN => 1,
DBICTEST_FIREBIRD_ODBC_USER => 0,
DBICTEST_FIREBIRD_ODBC_PASS => 0,
],
},
};
### Public API
sub import {
my $class = shift;
if (@_) {
my $action = shift;
if ($action eq '-die_without') {
my $err;
{
local $@;
eval { $class->die_unless_req_ok_for(\@_); 1 }
or $err = $@;
}
die "\n$err\n" if $err;
}
elsif ($action eq '-list_missing') {
print $class->modreq_missing_for(\@_);
print "\n";
exit 0;
}
elsif ($action eq '-skip_all_without') {
# sanity check - make sure ->current_test is 0 and no plan has been declared
do {
local $@;
defined eval {
Test::Builder->new->current_test
or
Test::Builder->new->has_plan
};
} and croak("Unable to invoke -skip_all_without after testing has started");
if ( my $missing = $class->req_missing_for(\@_) ) {
die ("\nMandatory requirements not satisfied during release-testing: $missing\n\n")
if $ENV{RELEASE_TESTING} and $class->_groups_to_reqs(\@_)->{release_testing_mandatory};
print "1..0 # SKIP requirements not satisfied: $missing\n";
exit 0;
}
}
elsif ($action =~ /^-/) {
croak "Unknown import-time action '$action'";
}
else {
croak "$class is not an exporter, unable to import '$action'";
}
}
1;
}
sub unimport {
croak( __PACKAGE__ . " does not implement unimport" );
}
# OO for (mistakenly considered) ease of extensibility, not due to any need to
# carry state of any sort. This API is currently used outside, so leave as-is.
# FIXME - make sure to not propagate this further if module is extracted as a
# standalone library - keep the stupidity to a DBIC-secific shim!
#
sub req_list_for {
shift->_groups_to_reqs(shift)->{effective_modreqs};
}
sub modreq_list_for {
shift->_groups_to_reqs(shift)->{modreqs};
}
sub req_group_list {
+{ map
{ $_ => $_[0]->_groups_to_reqs($_) }
grep { $_ !~ /^_/ } keys %$dbic_reqs
}
}
sub req_errorlist_for { shift->modreq_errorlist_for(shift) } # deprecated
sub modreq_errorlist_for {
my ($self, $groups) = @_;
$self->_errorlist_for_modreqs( $self->_groups_to_reqs($groups)->{modreqs} );
}
sub req_ok_for {
shift->req_missing_for(shift) ? 0 : 1;
}
sub req_missing_for {
my ($self, $groups) = @_;
my $reqs = $self->_groups_to_reqs($groups);
my $mods_missing = $reqs->{missing_envvars}
? $self->_list_physically_missing_modules( $reqs->{modreqs} )
: $self->modreq_missing_for($groups)
;
return '' if
! $mods_missing
and
! $reqs->{missing_envvars}
;
my @res = $mods_missing || ();
push @res, 'the following group(s) of environment variables: ' . join ' and ', sort map
{ __envvar_group_desc($_) }
@{$reqs->{missing_envvars}}
if $reqs->{missing_envvars};
return (
( join ' as well as ', @res )
.
( $reqs->{modreqs_fully_documented} ? " (see @{[ ref $self || $self ]} documentation for details)" : '' ),
);
}
sub modreq_missing_for {
my ($self, $groups) = @_;
my $reqs = $self->_groups_to_reqs($groups);
my $modreq_errors = $self->_errorlist_for_modreqs($reqs->{modreqs})
or return '';
join ' ', map
{ $reqs->{modreqs}{$_} ? "$_~$reqs->{modreqs}{$_}" : $_ }
sort { lc($a) cmp lc($b) } keys %$modreq_errors
;
}
my $tb;
sub skip_without {
my ($self, $groups) = @_;
$tb ||= do { local $@; eval { Test::Builder->new } }
or croak "Calling skip_without() before loading Test::Builder makes no sense";
if ( my $err = $self->req_missing_for($groups) ) {
my ($fn, $ln) = (caller(0))[1,2];
$tb->skip("block in $fn around line $ln requires $err");
local $^W = 0;
last SKIP;
}
1;
}
sub die_unless_req_ok_for {
if (my $err = shift->req_missing_for(shift) ) {
die "Unable to continue due to missing requirements: $err\n";
}
}
### Private functions
# potentially shorten group desc
sub __envvar_group_desc {
my @envs = @{$_[0]};
my (@res, $last_prefix);
while (my $ev = shift @envs) {
my ($pref, $sep, $suff) = split / ([\_\-]) (?= [^\_\-]+ \z )/x, $ev;
if ( defined $sep and ($last_prefix||'') eq $pref ) {
push @res, "...${sep}${suff}"
}
else {
push @res, $ev;
}
$last_prefix = $pref if $sep;
}
join '/', @res;
}
my $groupname_re = qr/ [a-z_] [0-9_a-z]* /x;
my $modname_re = qr/ [A-Z_a-z] [0-9A-Z_a-z]* (?:::[0-9A-Z_a-z]+)* /x;
my $modver_re = qr/ [0-9]+ (?: \. [0-9]+ )? /x;
# Expand includes from a random group in a specific order:
# nonvariable groups first, then their includes, then the variable groups,
# then their includes.
# This allows reliably marking the rest of the mod reqs as variable (this is
# also why variable includes are currently not allowed)
sub __expand_includes {
my ($groups, $seen) = @_;
# !! DIFFERENT !! behavior and return depending on invocation mode
# (easier to recurse this way)
my $is_toplevel = $seen
? 0
: !! ($seen = {})
;
my ($res_per_type, $missing_envvars);
# breadth-first evaluation, with non-variable includes on top
for my $g (@$groups) {
croak "Invalid requirement group name '$g': only ascii alphanumerics and _ are allowed"
if $g !~ qr/ \A $groupname_re \z/x;
my $r = $dbic_reqs->{$g}
or croak "Requirement group '$g' is not defined";
# always do this check *before* the $seen check
croak "Group '$g' with variable effective_modreqs can not be specified as an 'include'"
if ( $r->{env} and ! $is_toplevel );
next if $seen->{$g}++;
my $req_type = 'static';
if ( my @e = @{$r->{env}||[]} ) {
croak "Unexpected 'env' attribute under group '$g' (only allowed in test_* groups)"
unless $g =~ /^test_/;
croak "Unexpected *odd* list in 'env' under group '$g'"
if @e % 2;
# deconstruct the whole thing
my (@group_envnames_list, $some_envs_required, $some_required_missing);
while (@e) {
push @group_envnames_list, my $envname = shift @e;
# env required or not
next unless shift @e;
$some_envs_required ||= 1;
$some_required_missing ||= (
! defined $ENV{$envname}
or
! length $ENV{$envname}
);
}
croak "None of the envvars in group '$g' declared as required, making the requirement moot"
unless $some_envs_required;
if ($some_required_missing) {
push @{$missing_envvars->{$g}}, \@group_envnames_list;
$req_type = 'variable';
}
}
push @{$res_per_type->{"base_${req_type}"}}, $g;
if (my $i = $dbic_reqs->{$g}{include}) {
$i = [ $i ] unless ref $i eq 'ARRAY';
croak "Malformed 'include' for group '$g': must be another existing group name or arrayref of existing group names"
unless @$i;
push @{$res_per_type->{"incs_${req_type}"}}, @$i;
}
}
my @ret = map {
@{ $res_per_type->{"base_${_}"} || [] },
( $res_per_type->{"incs_${_}"} ? __expand_includes( $res_per_type->{"incs_${_}"}, $seen ) : () ),
} qw(static variable);
return ! $is_toplevel ? @ret : do {
my $rv = {};
$rv->{$_} = {
idx => 1 + keys %$rv,
missing_envvars => $missing_envvars->{$_},
} for @ret;
$rv->{$_}{user_requested} = 1 for @$groups;
$rv;
};
}
### Private OO API
our %req_unavailability_cache;
# this method is just a lister and envvar/metadata checker - it does not try to load anything
sub _groups_to_reqs {
my ($self, $want) = @_;
$want = [ $want || () ]
unless ref $want eq 'ARRAY';
croak "@{[ (caller(1))[3] ]}() expects a requirement group name or arrayref of group names"
unless @$want;
my $ret = {
modreqs => {},
modreqs_fully_documented => 1,
};
my $groups;
for my $piece (@$want) {
if ($piece =~ qr/ \A $groupname_re \z /x) {
push @$groups, $piece;
}
elsif ( my ($mod, $ver) = $piece =~ qr/ \A ($modname_re) \>\= ($modver_re) \z /x ) {
croak "Ad hoc module specification lists '$mod' twice"
if exists $ret->{modreqs}{$mod};
croak "Ad hoc module specification '${mod} >= $ver' (or greater) not listed in the test_adhoc optdep group" if (
! defined $dbic_reqs->{test_adhoc}{req}{$mod}
or
$dbic_reqs->{test_adhoc}{req}{$mod} < $ver
);
$ret->{modreqs}{$mod} = $ver;
$ret->{modreqs_fully_documented} = 0;
}
else {
croak "Unsupported argument '$piece' supplied to @{[ (caller(1))[3] ]}()"
}
}
my $all_groups = __expand_includes($groups);
# pre-assemble list of augmentations, perform basic sanity checks
# Note that below we *DO NOT* respect the source/target reationship, but
# instead always default to augment the "later" group
# This is done so that the "stable/variable" boundary keeps working as
# expected
my $augmentations;
for my $requesting_group (keys %$all_groups) {
if (my $ag = $dbic_reqs->{$requesting_group}{augment}) {
for my $target_group (keys %$ag) {
croak "Group '$requesting_group' claims to augment a non-existent group '$target_group'"
unless $dbic_reqs->{$target_group};
croak "Augmentation combined with variable effective_modreqs currently unsupported for group '$requesting_group'"
if $dbic_reqs->{$requesting_group}{env};
croak "Augmentation of group '$target_group' with variable effective_modreqs unsupported (requested by '$requesting_group')"
if $dbic_reqs->{$target_group}{env};
if (my @foreign = grep { $_ ne 'req' } keys %{$ag->{$target_group}} ) {
croak "Only 'req' augmentations are currently supported (group '$requesting_group' attempts to alter '$foreign[0]' of group '$target_group'";
}
$ret->{augments}{$target_group} = 1;
# no augmentation for stuff that hasn't been selected
if ( $all_groups->{$target_group} and my $ar = $ag->{$target_group}{req} ) {
push @{$augmentations->{
( $all_groups->{$requesting_group}{idx} < $all_groups->{$target_group}{idx} )
? $target_group
: $requesting_group
}}, $ar;
}
}
}
}
for my $group (sort { $all_groups->{$a}{idx} <=> $all_groups->{$b}{idx} } keys %$all_groups ) {
my $group_reqs = $dbic_reqs->{$group}{req};
# sanity-check
for my $req_bag ($group_reqs, @{ $augmentations->{$group} || [] } ) {
for (keys %$req_bag) {
$_ =~ / \A $modname_re \z /x
or croak "Requirement '$_' in group '$group' is not a valid module name";
# !!!DO NOT CHANGE!!!
# remember - version.pm may not be available on the system
croak "Requirement '$_' in group '$group' specifies an invalid version '$req_bag->{$_}' (only plain non-underscored floating point decimals are supported)"
if ( ($req_bag->{$_}||0) !~ qr/ \A $modver_re \z /x );
}
}
if (my $e = $all_groups->{$group}{missing_envvars}) {
push @{$ret->{missing_envvars}}, @$e;
}
# assemble into the final ret
for my $type (
'modreqs',
( $ret->{missing_envvars} ? () : 'effective_modreqs' ),
) {
for my $req_bag ($group_reqs, @{ $augmentations->{$group} || [] } ) {
for my $mod (keys %$req_bag) {
$ret->{$type}{$mod} = $req_bag->{$mod}||0 if (
! exists $ret->{$type}{$mod}
or
# we sanitized the version to be numeric above - we can just -gt it
($req_bag->{$mod}||0) > $ret->{$type}{$mod}
);
}
}
}
$ret->{modreqs_fully_documented} &&= !!$dbic_reqs->{$group}{pod}
if $all_groups->{$group}{user_requested};
$ret->{release_testing_mandatory} ||= !!$dbic_reqs->{$group}{release_testing_mandatory};
}
return $ret;
}
# this method tries to find/load specified modreqs and returns a hashref of
# module/loaderror pairs for anything that failed
sub _errorlist_for_modreqs {
# args supposedly already went through _groups_to_reqs and are therefore sanitized
# safe to eval at will
my ($self, $reqs) = @_;
my $ret;
for my $m ( keys %$reqs ) {
my $v = $reqs->{$m};
if (! exists $req_unavailability_cache{$m}{$v} ) {
local $@;
eval( "require $m;" . ( $v ? "$m->VERSION(q($v))" : '' ) );
$req_unavailability_cache{$m}{$v} = $@;
}
$ret->{$m} = $req_unavailability_cache{$m}{$v}
if $req_unavailability_cache{$m}{$v};
}
$ret;
}
# Unlike the above DO NOT try to load anything
# This is executed when some needed envvars are not available
# which in turn means a module load will never be reached anyway
# This is important because some modules (especially DBDs) can be
# *really* fickle when a require() is attempted, with pretty confusing
# side-effects (especially on windows)
sub _list_physically_missing_modules {
my ($self, $modreqs) = @_;
# in case there is a coderef in @INC there is nothing we can definitively prove
# so short circuit directly
return '' if grep { length ref $_ } @INC;
my @definitely_missing;
for my $mod (keys %$modreqs) {
(my $fn = $mod . '.pm') =~ s|::|/|g;
push @definitely_missing, $mod unless grep
# this should work on any combination of slashes
{ $_ and -d $_ and -f "$_/$fn" and -r "$_/$fn" }
@INC
;
}
join ' ', map
{ $modreqs->{$_} ? "$_~$modreqs->{$_}" : $_ }
sort { lc($a) cmp lc($b) } @definitely_missing
;
}
# This is to be called by the author only (automatically in Makefile.PL)
sub _gen_pod {
my ($class, $distver, $pod_dir) = @_;
die "No POD root dir supplied" unless $pod_dir;
$distver ||=
eval {
require DBIx::Class::Schema::Loader;
DBIx::Class::Schema::Loader->VERSION;
} ||
die
"\n\n---------------------------------------------------------------------\n" .
'Unable to load core DBIx::Class::Schema::Loader module to determine current version, '.
'possibly due to missing dependencies. Author-mode autodocumentation ' .
"halted\n\n" . $@ .
"\n\n---------------------------------------------------------------------\n"
;
# do not ask for a recent version, use 1.x API calls
# this *may* execute on a smoker with old perl or whatnot
require File::Path;
(my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
(my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
(my $dir = $podfn) =~ s|/[^/]+$||;
File::Path::mkpath([$dir]);
my $moosever = $class->req_list_for('use_moose')->{'Moose'}
or die "Hrmm? No Moose dep?";
my @chunks;
#@@
#@@ HEADER
#@@
push @chunks, <<"EOC";
#########################################################################
##################### A U T O G E N E R A T E D ########################
#########################################################################
#
# The contents of this POD file are auto-generated. Any changes you make
# will be lost. If you need to change the generated text edit _gen_pod()
# at the end of $modfn
#
=head1 NAME
$class - Optional module dependency specifications (for module authors)
EOC
#@@
#@@ SYNOPSIS HEADING
#@@
push @chunks, <<"EOC";
=head1 SYNOPSIS
Somewhere in your build-file (e.g. L<ExtUtils::MakeMaker>'s F<Makefile.PL>):
...
\$EUMM_ARGS{CONFIGURE_REQUIRES} = {
\%{ \$EUMM_ARGS{CONFIGURE_REQUIRES} || {} },
'DBIx::Class::Schema::Loader' => '$distver',
};
...
my %DBIC_CONFIG_AND_ORACLE_DEPS = %{ eval {
require $class;
$class->req_list_for([qw( dbicdump_config rdbms_oracle )]);
} || {} };
\$EUMM_ARGS{PREREQ_PM} = {
\%DBIC_CONFIG_AND_ORACLE_DEPS,
\%{ \$EUMM_ARGS{PREREQ_PM} || {} },
};
...
ExtUtils::MakeMaker::WriteMakefile(\%EUMM_ARGS);
B<Note>: The C<eval> protection within the example is due to support for
requirements during L<the C<configure> build phase|CPAN::Meta::Spec/Phases>
not being available on a sufficient portion of production installations of
Perl. Robust support for such dependency requirements is available in the
L<CPAN> installer only since version C<1.94_56> first made available for
production with perl version C<5.12>. It is the belief of the current
maintainer that support for requirements during the C<configure> build phase
will not be sufficiently ubiquitous until the B<year 2020> at the earliest,
hence the extra care demonstrated above. It should also be noted that some
3rd party installers (e.g. L<cpanminus|App::cpanminus>) do the right thing
with configure requirements independent from the versions of perl and CPAN
available.
EOC
#@@
#@@ DESCRIPTION HEADING
#@@
push @chunks, <<'EOC';
=head1 DESCRIPTION
Some of the less-frequently used features of L<DBIx::Class::Schema::Loader> have external
module dependencies on their own. In order not to burden the average user
with modules they will never use, these optional dependencies are not included
in the base Makefile.PL. Instead an exception with a descriptive message is
thrown when a specific feature can't find one or several modules required for
its operation. This module is the central holding place for the current list
of such dependencies, for DBIx::Class::Schema::Loader core authors, and DBIx::Class::Schema::Loader extension
authors alike.
Dependencies are organized in L<groups|/CURRENT REQUIREMENT GROUPS> where each
group can list one or more required modules, with an optional minimum version
(or 0 for any version). In addition groups prefixed with C<test_> can specify
a set of environment variables, some (or all) of which are marked as required
for the group to be considered by L</req_list_for>
Each group name (or a combination thereof) can be used in the
L<public methods|/METHODS> as described below.
EOC
#@@
#@@ REQUIREMENT GROUPLIST HEADING
#@@
push @chunks, '=head1 CURRENT REQUIREMENT GROUPS';
my $standalone_info;
for my $group (sort keys %$dbic_reqs) {
my $info = $standalone_info->{$group} ||= $class->_groups_to_reqs($group);
next unless (
$info->{modreqs_fully_documented}
and
( $info->{augments} or $info->{modreqs} )
);
my $p = $dbic_reqs->{$group}{pod};
push @chunks, (
"=head2 $p->{title}",
"=head3 $group",
$p->{desc},
'=over',
);
if ( keys %{ $info->{modreqs}||{} } ) {
push @chunks, map
{ "=item * $_" . ($info->{modreqs}{$_} ? " >= $info->{modreqs}{$_}" : '') }
( sort keys %{ $info->{modreqs} } )
;
}
else {
push @chunks, '=item * No standalone requirements',
}
push @chunks, '=back';
for my $ag ( sort keys %{ $info->{augments} || {} } ) {
my $ag_info = $standalone_info->{$ag} ||= $class->_groups_to_reqs($ag);
my $newreqs = $class->modreq_list_for([ $group, $ag ]);
for (keys %$newreqs) {
delete $newreqs->{$_} if (
( defined $info->{modreqs}{$_} and $info->{modreqs}{$_} == $newreqs->{$_} )
or
( defined $ag_info->{modreqs}{$_} and $ag_info->{modreqs}{$_} == $newreqs->{$_} )
);
}
if (keys %$newreqs) {
push @chunks, (
"Combined with L</$ag> additionally requires:",
'=over',
( map
{ "=item * $_" . ($newreqs->{$_} ? " >= $newreqs->{$_}" : '') }
( sort keys %$newreqs )
),
'=back',
);
}
}
}
#@@
#@@ API DOCUMENTATION HEADING
#@@
push @chunks, <<'EOC';
=head1 IMPORT-LIKE ACTIONS
Even though this module is not an L<Exporter>, it recognizes several C<actions>
supplied to its C<import> method.
=head2 -skip_all_without
=over
=item Arguments: @group_names
=back
A convenience wrapper for use during testing:
EOC
push @chunks, " use $class -skip_all_without => qw(admin test_rdbms_mysql);";
push @chunks, 'Roughly equivalent to the following code:';
push @chunks, sprintf <<'EOS', ($class) x 2;
BEGIN {
require %s;
if ( my $missing = %s->req_missing_for(\@group_names_) ) {
print "1..0 # SKIP requirements not satisfied: $missing\n";
exit 0;
}
}
EOS
push @chunks, <<'EOC';
It also takes into account the C<RELEASE_TESTING> environment variable and
behaves like L</-die_without> for any requirement groups marked as
C<release_testing_mandatory>.
=head2 -die_without
=over
=item Arguments: @group_names
=back
A convenience wrapper around L</die_unless_req_ok_for>:
EOC
push @chunks, " use $class -die_without => qw(deploy admin);";
push @chunks, <<'EOC';
=head2 -list_missing
=over
=item Arguments: @group_names
=back
A convenience wrapper around L</modreq_missing_for>:
perl -Ilib -MDBIx::Class::Schema::Loader::Optional::Dependencies=-list_missing,dbicdump_config,rdbms_oracle | cpanm
=head1 METHODS
=head2 req_group_list
=over
=item Arguments: none
=item Return Value: \%list_of_requirement_groups
=back
This method should be used by DBIx::Class::Schema::Loader packagers, to get a hashref of all
dependencies B<keyed> by dependency group. Each key (group name), or a combination
thereof (as an arrayref) can be supplied to the methods below.
The B<values> of the returned hash are currently a set of options B<without a
well defined structure>. If you have use for any of the contents - contact the
maintainers, instead of treating this as public (left alone stable) API.
=head2 req_list_for
=over
=item Arguments: $group_name | \@group_names
=item Return Value: \%set_of_module_version_pairs
=back
This method should be used by DBIx::Class::Schema::Loader extension authors, to determine the
version of modules a specific set of features requires for this version of
DBIx::Class::Schema::Loader (regardless of their availability on the system).
See the L</SYNOPSIS> for a real-world example.
When handling C<test_*> groups this method behaves B<differently> from
L</modreq_list_for> below (and is the only such inconsistency among the
C<req_*> methods). If a particular group declares as requirements some
C<environment variables> and these requirements are not satisfied (the envvars
are unset) - then the C<module requirements> of this group are not included in
the returned list.
=head2 modreq_list_for
=over
=item Arguments: $group_name | \@group_names
=item Return Value: \%set_of_module_version_pairs
=back
Same as L</req_list_for> but does not take into consideration any
C<environment variable requirements> - returns just the list of required
modules.
=head2 req_ok_for
=over
=item Arguments: $group_name | \@group_names
=item Return Value: 1|0
=back
Returns true or false depending on whether all modules/envvars required by
the group(s) are loadable/set on the system.
=head2 req_missing_for
=over
=item Arguments: $group_name | \@group_names
=item Return Value: $error_message_string
=back
Returns a single-line string suitable for inclusion in larger error messages.
This method would normally be used by DBIx::Class::Schema::Loader core features, to indicate to
the user that they need to install specific modules and/or set specific
environment variables before being able to use a specific feature set.
For example if some of the requirements for C<deploy> are not available,
the returned string could look like:
EOC
push @chunks, qq{ "Moose~$moosever" (see $class documentation for details)};
push @chunks, <<'EOC';
The author is expected to prepend the necessary text to this message before
returning the actual error seen by the user. See also L</modreq_missing_for>
=head2 modreq_missing_for
=over
=item Arguments: $group_name | \@group_names
=item Return Value: $error_message_string
=back
Same as L</req_missing_for> except that the error string is guaranteed to be
either empty, or contain a set of module requirement specifications suitable
for piping to e.g. L<cpanminus|App::cpanminus>. The method explicitly does not
attempt to validate the state of required environment variables (if any).
For instance if some of the requirements for C<deploy> are not available,
the returned string could look like:
EOC
push @chunks, qq{ "Moose~$moosever"};
push @chunks, <<'EOC';
See also L</-list_missing>.
=head2 skip_without
=over
=item Arguments: $group_name | \@group_names
=back
A convenience wrapper around L<skip|Test::More/SKIP>. It does not take neither
a reason (it is generated by L</req_missing_for>) nor an amount of skipped tests
(it is always C<1>, thus mandating unconditional use of
L<done_testing|Test::More/done_testing>). Most useful in combination with ad hoc
requirement specifications:
EOC
push @chunks, <<EOC;
SKIP: {
$class->skip_without([ deploy YAML>=0.90 ]);
...
}
EOC
push @chunks, <<'EOC';
=head2 die_unless_req_ok_for
=over
=item Arguments: $group_name | \@group_names
=back
Checks if L</req_ok_for> passes for the supplied group(s), and
in case of failure throws an exception including the information
from L</req_missing_for>. See also L</-die_without>.
=head2 modreq_errorlist_for
=over
=item Arguments: $group_name | \@group_names
=item Return Value: \%set_of_loaderrors_per_module
=back
Returns a hashref containing the actual errors that occurred while attempting
to load each module in the requirement group(s).
=head2 req_errorlist_for
Deprecated method name, equivalent (via proxy) to L</modreq_errorlist_for>.
EOC
#@@
#@@ FOOTER
#@@
push @chunks, <<'EOC';
=head1 FURTHER QUESTIONS?
Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
=head1 COPYRIGHT AND LICENSE
This module is free software L<copyright|DBIx::Class::Schema::Loader/COPYRIGHT AND LICENSE>
by the L<DBIx::Class::Schema::Loader (DBICSL) authors|DBIx::Class::Schema::Loader/AUTHORS>.
You can redistribute it and/or modify it under the same terms as the
L<DBIx::Class::Schema::Loader library|DBIx::Class::Schema::Loader/COPYRIGHT AND LICENSE>.
EOC
eval {
open (my $fh, '>', $podfn) or die;
print $fh join ("\n\n", @chunks) or die;
print $fh "\n" or die;
close ($fh) or die;
} or croak( "Unable to write $podfn: " . ( $! || $@ || 'unknown error') );
}
1;
|