← Index
NYTProf Performance Profile   « line view »
For starman worker -M FindBin --max-requests 50 --workers 2 --user=kohadev-koha --group kohadev-koha --pid /var/run/koha/kohadev/plack.pid --daemonize --access-log /var/log/koha/kohadev/plack.log --error-log /var/log/koha/kohadev/plack-error.log -E deployment --socket /var/run/koha/kohadev/plack.sock /etc/koha/sites/kohadev/plack.psgi
  Run on Fri Jan 8 14:31:06 2016
Reported on Fri Jan 8 14:31:36 2016

Filename/usr/share/perl5/DBIx/Class/Optional/Dependencies.pm
StatementsExecuted 35 statements in 2.19ms
Subroutines
Calls P F Exclusive
Time		 Inclusive
Time		 Subroutine
11116µs25µsDBIx::Class::Optional::Dependencies::::BEGIN@3DBIx::Class::Optional::Dependencies::BEGIN@3
1118µs16µsDBIx::Class::Optional::Dependencies::::BEGIN@4DBIx::Class::Optional::Dependencies::BEGIN@4
1114µs4µsDBIx::Class::Optional::Dependencies::::BEGIN@6DBIx::Class::Optional::Dependencies::BEGIN@6
0000s0sDBIx::Class::Optional::Dependencies::::_check_depsDBIx::Class::Optional::Dependencies::_check_deps
0000s0sDBIx::Class::Optional::Dependencies::::_gen_podDBIx::Class::Optional::Dependencies::_gen_pod
0000s0sDBIx::Class::Optional::Dependencies::::die_unless_req_ok_forDBIx::Class::Optional::Dependencies::die_unless_req_ok_for
0000s0sDBIx::Class::Optional::Dependencies::::req_errorlist_forDBIx::Class::Optional::Dependencies::req_errorlist_for
0000s0sDBIx::Class::Optional::Dependencies::::req_group_listDBIx::Class::Optional::Dependencies::req_group_list
0000s0sDBIx::Class::Optional::Dependencies::::req_list_forDBIx::Class::Optional::Dependencies::req_list_for
0000s0sDBIx::Class::Optional::Dependencies::::req_missing_forDBIx::Class::Optional::Dependencies::req_missing_for
0000s0sDBIx::Class::Optional::Dependencies::::req_ok_forDBIx::Class::Optional::Dependencies::req_ok_for
Call graph for these subroutines as a Graphviz dot language file.
Line State
ments		 Time
on line		 Calls Time
in subs		 Code
1package DBIx::Class::Optional::Dependencies;
2
3244µs234µs
# spent 25µs (16+9) within DBIx::Class::Optional::Dependencies::BEGIN@3 which was called: # once (16µs+9µs) by DBIx::Class::BEGIN@21 at line 3
use warnings;
# spent 25µs making 1 call to DBIx::Class::Optional::Dependencies::BEGIN@3 # spent 9µs making 1 call to warnings::import
4233µs224µs
# spent 16µs (8+7) within DBIx::Class::Optional::Dependencies::BEGIN@4 which was called: # once (8µs+7µs) by DBIx::Class::BEGIN@21 at line 4
use strict;
# spent 16µs making 1 call to DBIx::Class::Optional::Dependencies::BEGIN@4 # spent 8µs making 1 call to strict::import
5
621.93ms14µs
# spent 4µs within DBIx::Class::Optional::Dependencies::BEGIN@6 which was called: # once (4µs+0s) by DBIx::Class::BEGIN@21 at line 6
use Carp ();
# spent 4µs making 1 call to DBIx::Class::Optional::Dependencies::BEGIN@6
7
8# NO EXTERNAL NON-5.8.1 CORE DEPENDENCIES EVER (e.g. C::A::G)
9# This module is to be loaded by Makefile.PM on a pristine system
10
11# POD is generated automatically by calling _gen_pod from the
12# Makefile.PL in $AUTHOR mode
13
14# NOTE: the rationale for 2 JSON::Any versions is that
15# we need the newer only to work around JSON::XS, which
16# itself is an optional dep
1712µsmy $min_json_any = {
18 'JSON::Any' => '1.23',
19};
201700nsmy $test_and_dist_json_any = {
21 'JSON::Any' => '1.31',
22};
23
2412µsmy $moose_basic = {
25 'Moose' => '0.98',
26 'MooseX::Types' => '0.21',
27 'MooseX::Types::LoadableClass' => '0.011',
28};
29
3012µsmy $replicated = {
31 %$moose_basic,
32};
33
3413µsmy $admin_basic = {
35 %$moose_basic,
36 %$min_json_any,
37 'MooseX::Types::Path::Class' => '0.05',
38 'MooseX::Types::JSON' => '0.02',
39};
40
4114µsmy $admin_script = {
42 %$moose_basic,
43 %$admin_basic,
44 'Getopt::Long::Descriptive' => '0.081',
45 'Text::CSV' => '1.16',
46};
47
4814µsmy $datetime_basic = {
49 'DateTime' => '0.55',
50 'DateTime::Format::Strptime' => '1.2',
51};
52
5312µsmy $id_shortener = {
54 'Math::BigInt' => '1.80',
55 'Math::Base36' => '0.07',
56};
57
5812µsmy $rdbms_sqlite = {
59 'DBD::SQLite' => '0',
60};
6112µsmy $rdbms_pg = {
62 'DBD::Pg' => '0',
63};
641600nsmy $rdbms_mssql_odbc = {
65 'DBD::ODBC' => '0',
66};
671500nsmy $rdbms_mssql_sybase = {
68 'DBD::Sybase' => '0',
69};
7011µsmy $rdbms_mssql_ado = {
71 'DBD::ADO' => '0',
72};
731300nsmy $rdbms_msaccess_odbc = {
74 'DBD::ODBC' => '0',
75};
761300nsmy $rdbms_msaccess_ado = {
77 'DBD::ADO' => '0',
78};
7911µsmy $rdbms_mysql = {
80 'DBD::mysql' => '0',
81};
8212µsmy $rdbms_oracle = {
83 'DBD::Oracle' => '0',
84 %$id_shortener,
85};
861400nsmy $rdbms_ase = {
87 'DBD::Sybase' => '0',
88};
891400nsmy $rdbms_db2 = {
90 'DBD::DB2' => '0',
91};
921400nsmy $rdbms_db2_400 = {
93 'DBD::ODBC' => '0',
94};
951600nsmy $rdbms_informix = {
96 'DBD::Informix' => '0',
97};
981900nsmy $rdbms_sqlanywhere = {
99 'DBD::SQLAnywhere' => '0',
100};
1011300nsmy $rdbms_sqlanywhere_odbc = {
102 'DBD::ODBC' => '0',
103};
1041600nsmy $rdbms_firebird = {
105 'DBD::Firebird' => '0',
106};
1071500nsmy $rdbms_firebird_interbase = {
108 'DBD::InterBase' => '0',
109};
1101300nsmy $rdbms_firebird_odbc = {
111 'DBD::ODBC' => '0',
112};
113
1141109µsmy $reqs = {
115 replicated => {
116 req => $replicated,
117 pod => {
118 title => 'Storage::Replicated',
119 desc => 'Modules required for L<DBIx::Class::Storage::DBI::Replicated>',
120 },
121 },
122
123 test_replicated => {
124 req => {
125 %$replicated,
126 'Test::Moose' => '0',
127 },
128 },
129
130
131 admin => {
132 req => {
133 %$admin_basic,
134 },
135 pod => {
136 title => 'DBIx::Class::Admin',
137 desc => 'Modules required for the DBIx::Class administrative library',
138 },
139 },
140
141 admin_script => {
142 req => {
143 %$admin_script,
144 },
145 pod => {
146 title => 'dbicadmin',
147 desc => 'Modules required for the CLI DBIx::Class interface dbicadmin',
148 },
149 },
150
151 deploy => {
152 req => {
153 'SQL::Translator' => '0.11018',
154 },
155 pod => {
156 title => 'Storage::DBI::deploy()',
157 desc => 'Modules required for L<DBIx::Class::Storage::DBI/deployment_statements> and L<DBIx::Class::Schema/deploy>',
158 },
159 },
160
161 id_shortener => {
162 req => $id_shortener,
163 },
164
165 test_component_accessor => {
166 req => {
167 'Class::Unload' => '0.07',
168 },
169 },
170
171 test_pod => {
172 req => {
173 'Test::Pod' => '1.42',
174 },
175 },
176
177 test_podcoverage => {
178 req => {
179 'Test::Pod::Coverage' => '1.08',
180 'Pod::Coverage' => '0.20',
181 },
182 },
183
184 test_whitespace => {
185 req => {
186 'Test::EOL' => '1.0',
187 'Test::NoTabs' => '0.9',
188 },
189 },
190
191 test_strictures => {
192 req => {
193 'Test::Strict' => '0.20',
194 },
195 },
196
197 test_prettydebug => {
198 req => $min_json_any,
199 },
200
201 test_admin_script => {
202 req => {
203 %$admin_script,
204 %$test_and_dist_json_any,
205 'JSON' => 0,
206 'JSON::PP' => 0,
207 'Cpanel::JSON::XS' => 0,
208 'JSON::XS' => 0,
209 $^O eq 'MSWin32'
210 # for t/admin/10script.t
211 ? ('Win32::ShellQuote' => 0)
212 # DWIW does not compile (./configure even) on win32
213 : ('JSON::DWIW' => 0 )
214 ,
215 }
216 },
217
218 test_leaks_heavy => {
219 req => {
220 'Class::MethodCache' => '0.02',
221 'PadWalker' => '1.06',
222 },
223 },
224
225 test_dt => {
226 req => $datetime_basic,
227 },
228
229 test_dt_sqlite => {
230 req => {
231 %$datetime_basic,
232 # t/36datetime.t
233 # t/60core.t
234 'DateTime::Format::SQLite' => '0',
235 },
236 },
237
238 test_dt_mysql => {
239 req => {
240 %$datetime_basic,
241 # t/inflate/datetime_mysql.t
242 # (doesn't need Mysql itself)
243 'DateTime::Format::MySQL' => '0',
244 },
245 },
246
247 test_dt_pg => {
248 req => {
249 %$datetime_basic,
250 # t/inflate/datetime_pg.t
251 # (doesn't need PG itself)
252 'DateTime::Format::Pg' => '0.16004',
253 },
254 },
255
256 test_cdbicompat => {
257 req => {
258 'Class::DBI::Plugin::DeepAbstractSearch' => '0',
259 %$datetime_basic,
260 'Time::Piece::MySQL' => '0',
261 'Date::Simple' => '3.03',
262 },
263 },
264
265 # this is just for completeness as SQLite
266 # is a core dep of DBIC for testing
267 rdbms_sqlite => {
268 req => {
269 %$rdbms_sqlite,
270 },
271 pod => {
272 title => 'SQLite support',
273 desc => 'Modules required to connect to SQLite',
274 },
275 },
276
277 rdbms_pg => {
278 req => {
279 # when changing this list make sure to adjust xt/optional_deps.t
280 %$rdbms_pg,
281 },
282 pod => {
283 title => 'PostgreSQL support',
284 desc => 'Modules required to connect to PostgreSQL',
285 },
286 },
287
288 rdbms_mssql_odbc => {
289 req => {
290 %$rdbms_mssql_odbc,
291 },
292 pod => {
293 title => 'MSSQL support via DBD::ODBC',
294 desc => 'Modules required to connect to MSSQL via DBD::ODBC',
295 },
296 },
297
298 rdbms_mssql_sybase => {
299 req => {
300 %$rdbms_mssql_sybase,
301 },
302 pod => {
303 title => 'MSSQL support via DBD::Sybase',
304 desc => 'Modules required to connect to MSSQL via DBD::Sybase',
305 },
306 },
307
308 rdbms_mssql_ado => {
309 req => {
310 %$rdbms_mssql_ado,
311 },
312 pod => {
313 title => 'MSSQL support via DBD::ADO (Windows only)',
314 desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only',
315 },
316 },
317
318 rdbms_msaccess_odbc => {
319 req => {
320 %$rdbms_msaccess_odbc,
321 },
322 pod => {
323 title => 'MS Access support via DBD::ODBC',
324 desc => 'Modules required to connect to MS Access via DBD::ODBC',
325 },
326 },
327
328 rdbms_msaccess_ado => {
329 req => {
330 %$rdbms_msaccess_ado,
331 },
332 pod => {
333 title => 'MS Access support via DBD::ADO (Windows only)',
334 desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only',
335 },
336 },
337
338 rdbms_mysql => {
339 req => {
340 %$rdbms_mysql,
341 },
342 pod => {
343 title => 'MySQL support',
344 desc => 'Modules required to connect to MySQL',
345 },
346 },
347
348 rdbms_oracle => {
349 req => {
350 %$rdbms_oracle,
351 },
352 pod => {
353 title => 'Oracle support',
354 desc => 'Modules required to connect to Oracle',
355 },
356 },
357
358 rdbms_ase => {
359 req => {
360 %$rdbms_ase,
361 },
362 pod => {
363 title => 'Sybase ASE support',
364 desc => 'Modules required to connect to Sybase ASE',
365 },
366 },
367
368 rdbms_db2 => {
369 req => {
370 %$rdbms_db2,
371 },
372 pod => {
373 title => 'DB2 support',
374 desc => 'Modules required to connect to DB2',
375 },
376 },
377
378 rdbms_db2_400 => {
379 req => {
380 %$rdbms_db2_400,
381 },
382 pod => {
383 title => 'DB2 on AS/400 support',
384 desc => 'Modules required to connect to DB2 on AS/400',
385 },
386 },
387
388 rdbms_informix => {
389 req => {
390 %$rdbms_informix,
391 },
392 pod => {
393 title => 'Informix support',
394 desc => 'Modules required to connect to Informix',
395 },
396 },
397
398 rdbms_sqlanywhere => {
399 req => {
400 %$rdbms_sqlanywhere,
401 },
402 pod => {
403 title => 'SQLAnywhere support',
404 desc => 'Modules required to connect to SQLAnywhere',
405 },
406 },
407
408 rdbms_sqlanywhere_odbc => {
409 req => {
410 %$rdbms_sqlanywhere_odbc,
411 },
412 pod => {
413 title => 'SQLAnywhere support via DBD::ODBC',
414 desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC',
415 },
416 },
417
418 rdbms_firebird => {
419 req => {
420 %$rdbms_firebird,
421 },
422 pod => {
423 title => 'Firebird support',
424 desc => 'Modules required to connect to Firebird',
425 },
426 },
427
428 rdbms_firebird_interbase => {
429 req => {
430 %$rdbms_firebird_interbase,
431 },
432 pod => {
433 title => 'Firebird support via DBD::InterBase',
434 desc => 'Modules required to connect to Firebird via DBD::InterBase',
435 },
436 },
437
438 rdbms_firebird_odbc => {
439 req => {
440 %$rdbms_firebird_odbc,
441 },
442 pod => {
443 title => 'Firebird support via DBD::ODBC',
444 desc => 'Modules required to connect to Firebird via DBD::ODBC',
445 },
446 },
447
448# the order does matter because the rdbms support group might require
449# a different version that the test group
450 test_rdbms_pg => {
451 req => {
452 $ENV{DBICTEST_PG_DSN}
453 ? (
454 # when changing this list make sure to adjust xt/optional_deps.t
455 %$rdbms_pg,
456 'DBD::Pg' => '2.009002',
457 ) : ()
458 },
459 },
460
461 test_rdbms_mssql_odbc => {
462 req => {
463 $ENV{DBICTEST_MSSQL_ODBC_DSN}
464 ? (
465 %$rdbms_mssql_odbc,
466 ) : ()
467 },
468 },
469
470 test_rdbms_mssql_ado => {
471 req => {
472 $ENV{DBICTEST_MSSQL_ADO_DSN}
473 ? (
474 %$rdbms_mssql_ado,
475 ) : ()
476 },
477 },
478
479 test_rdbms_mssql_sybase => {
480 req => {
481 $ENV{DBICTEST_MSSQL_DSN}
482 ? (
483 %$rdbms_mssql_sybase,
484 ) : ()
485 },
486 },
487
488 test_rdbms_msaccess_odbc => {
489 req => {
490 $ENV{DBICTEST_MSACCESS_ODBC_DSN}
491 ? (
492 %$rdbms_msaccess_odbc,
493 %$datetime_basic,
494 'Data::GUID' => '0',
495 ) : ()
496 },
497 },
498
499 test_rdbms_msaccess_ado => {
500 req => {
501 $ENV{DBICTEST_MSACCESS_ADO_DSN}
502 ? (
503 %$rdbms_msaccess_ado,
504 %$datetime_basic,
505 'Data::GUID' => 0,
506 ) : ()
507 },
508 },
509
510 test_rdbms_mysql => {
511 req => {
512 $ENV{DBICTEST_MYSQL_DSN}
513 ? (
514 %$rdbms_mysql,
515 ) : ()
516 },
517 },
518
519 test_rdbms_oracle => {
520 req => {
521 $ENV{DBICTEST_ORA_DSN}
522 ? (
523 %$rdbms_oracle,
524 'DateTime::Format::Oracle' => '0',
525 'DBD::Oracle' => '1.24',
526 ) : ()
527 },
528 },
529
530 test_rdbms_ase => {
531 req => {
532 $ENV{DBICTEST_SYBASE_DSN}
533 ? (
534 %$rdbms_ase,
535 ) : ()
536 },
537 },
538
539 test_rdbms_db2 => {
540 req => {
541 $ENV{DBICTEST_DB2_DSN}
542 ? (
543 %$rdbms_db2,
544 ) : ()
545 },
546 },
547
548 test_rdbms_db2_400 => {
549 req => {
550 $ENV{DBICTEST_DB2_400_DSN}
551 ? (
552 %$rdbms_db2_400,
553 ) : ()
554 },
555 },
556
557 test_rdbms_informix => {
558 req => {
559 $ENV{DBICTEST_INFORMIX_DSN}
560 ? (
561 %$rdbms_informix,
562 ) : ()
563 },
564 },
565
566 test_rdbms_sqlanywhere => {
567 req => {
568 $ENV{DBICTEST_SQLANYWHERE_DSN}
569 ? (
570 %$rdbms_sqlanywhere,
571 ) : ()
572 },
573 },
574
575 test_rdbms_sqlanywhere_odbc => {
576 req => {
577 $ENV{DBICTEST_SQLANYWHERE_ODBC_DSN}
578 ? (
579 %$rdbms_sqlanywhere_odbc,
580 ) : ()
581 },
582 },
583
584 test_rdbms_firebird => {
585 req => {
586 $ENV{DBICTEST_FIREBIRD_DSN}
587 ? (
588 %$rdbms_firebird,
589 ) : ()
590 },
591 },
592
593 test_rdbms_firebird_interbase => {
594 req => {
595 $ENV{DBICTEST_FIREBIRD_INTERBASE_DSN}
596 ? (
597 %$rdbms_firebird_interbase,
598 ) : ()
599 },
600 },
601
602 test_rdbms_firebird_odbc => {
603 req => {
604 $ENV{DBICTEST_FIREBIRD_ODBC_DSN}
605 ? (
606 %$rdbms_firebird_odbc,
607 ) : ()
608 },
609 },
610
611 test_memcached => {
612 req => {
613 $ENV{DBICTEST_MEMCACHED}
614 ? (
615 'Cache::Memcached' => 0,
616 ) : ()
617 },
618 },
619
620 dist_dir => {
621 req => {
622 %$test_and_dist_json_any,
623 'ExtUtils::MakeMaker' => '6.64',
624 'Pod::Inherit' => '0.91',
625 },
626 },
627
628 dist_upload => {
629 req => {
630 'CPAN::Uploader' => '0.103001',
631 },
632 },
633
634};
635
6361200nsour %req_availability_cache;
637
638sub req_list_for {
639 my ($class, $group) = @_;
640
641 Carp::croak "req_list_for() expects a requirement group name"
642 unless $group;
643
644 my $deps = $reqs->{$group}{req}
645 or Carp::croak "Requirement group '$group' does not exist";
646
647 return { %$deps };
648}
649
650
651sub die_unless_req_ok_for {
652 my ($class, $group) = @_;
653
654 Carp::croak "die_unless_req_ok_for() expects a requirement group name"
655 unless $group;
656
657 $class->_check_deps($group)->{status}
658 or die sprintf( "Required modules missing, unable to continue: %s\n", $class->_check_deps($group)->{missing} );
659}
660
661sub req_ok_for {
662 my ($class, $group) = @_;
663
664 Carp::croak "req_ok_for() expects a requirement group name"
665 unless $group;
666
667 return $class->_check_deps($group)->{status};
668}
669
670sub req_missing_for {
671 my ($class, $group) = @_;
672
673 Carp::croak "req_missing_for() expects a requirement group name"
674 unless $group;
675
676 return $class->_check_deps($group)->{missing};
677}
678
679sub req_errorlist_for {
680 my ($class, $group) = @_;
681
682 Carp::croak "req_errorlist_for() expects a requirement group name"
683 unless $group;
684
685 return $class->_check_deps($group)->{errorlist};
686}
687
688sub _check_deps {
689 my ($class, $group) = @_;
690
691 return $req_availability_cache{$group} ||= do {
692
693 my $deps = $class->req_list_for ($group);
694
695 my %errors;
696 for my $mod (keys %$deps) {
697 my $req_line = "require $mod;";
698 if (my $ver = $deps->{$mod}) {
699 $req_line .= "$mod->VERSION($ver);";
700 }
701
702 eval $req_line;
703
704 $errors{$mod} = $@ if $@;
705 }
706
707 my $res;
708
709 if (keys %errors) {
710 my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) );
711 $missing .= " (see $class for details)" if $reqs->{$group}{pod};
712 $res = {
713 status => 0,
714 errorlist => \%errors,
715 missing => $missing,
716 };
717 }
718 else {
719 $res = {
720 status => 1,
721 errorlist => {},
722 missing => '',
723 };
724 }
725
726 $res;
727 };
728}
729
730sub req_group_list {
731 return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) };
732}
733
734# This is to be called by the author only (automatically in Makefile.PL)
735sub _gen_pod {
736 my ($class, $distver, $pod_dir) = @_;
737
738 die "No POD root dir supplied" unless $pod_dir;
739
740 $distver ||=
741 eval { require DBIx::Class; DBIx::Class->VERSION; }
742 ||
743 die
744"\n\n---------------------------------------------------------------------\n" .
745'Unable to load core DBIx::Class module to determine current version, '.
746'possibly due to missing dependencies. Author-mode autodocumentation ' .
747"halted\n\n" . $@ .
748"\n\n---------------------------------------------------------------------\n"
749 ;
750
751 # do not ask for a recent version, use 1.x API calls
752 # this *may* execute on a smoker with old perl or whatnot
753 require File::Path;
754
755 (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g;
756
757 (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/;
758 (my $dir = $podfn) =~ s|/[^/]+$||;
759
760 File::Path::mkpath([$dir]);
761
762 my $sqltver = $class->req_list_for ('deploy')->{'SQL::Translator'}
763 or die "Hrmm? No sqlt dep?";
764
765 my @chunks = (
766 <<"EOC",
767#########################################################################
768##################### A U T O G E N E R A T E D ########################
769#########################################################################
770#
771# The contents of this POD file are auto-generated. Any changes you make
772# will be lost. If you need to change the generated text edit _gen_pod()
773# at the end of $modfn
774#
775EOC
776 '=head1 NAME',
777 "$class - Optional module dependency specifications (for module authors)",
778 '=head1 SYNOPSIS',
779 <<"EOS",
780Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
781
782 ...
783
784 configure_requires 'DBIx::Class' => '$distver';
785
786 require $class;
787
788 my \$deploy_deps = $class->req_list_for('deploy');
789
790 for (keys %\$deploy_deps) {
791 requires \$_ => \$deploy_deps->{\$_};
792 }
793
794 ...
795
796Note that there are some caveats regarding C<configure_requires()>, more info
797can be found at L<Module::Install/configure_requires>
798EOS
799 '=head1 DESCRIPTION',
800 <<'EOD',
801Some of the less-frequently used features of L<DBIx::Class> have external
802module dependencies on their own. In order not to burden the average user
803with modules he will never use, these optional dependencies are not included
804in the base Makefile.PL. Instead an exception with a descriptive message is
805thrown when a specific feature is missing one or several modules required for
806its operation. This module is the central holding place for the current list
807of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
808authors alike.
809EOD
810 '=head1 CURRENT REQUIREMENT GROUPS',
811 <<'EOD',
812Dependencies are organized in C<groups> and each group can list one or more
813required modules, with an optional minimum version (or 0 for any version).
814The group name can be used in the
815EOD
816 );
817
818 for my $group (sort keys %$reqs) {
819 my $p = $reqs->{$group}{pod}
820 or next;
821
822 my $modlist = $reqs->{$group}{req}
823 or next;
824
825 next unless keys %$modlist;
826
827 push @chunks, (
828 "=head2 $p->{title}",
829 "$p->{desc}",
830 '=over',
831 ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ),
832 '=back',
833 "Requirement group: B<$group>",
834 );
835 }
836
837 push @chunks, (
838 '=head1 METHODS',
839 '=head2 req_group_list',
840 '=over',
841 '=item Arguments: none',
842 '=item Return Value: \%list_of_requirement_groups',
843 '=back',
844 <<'EOD',
845This method should be used by DBIx::Class packagers, to get a hashref of all
846dependencies keyed by dependency group. Each key (group name) can be supplied
847to one of the group-specific methods below.
848EOD
849
850 '=head2 req_list_for',
851 '=over',
852 '=item Arguments: $group_name',
853 '=item Return Value: \%list_of_module_version_pairs',
854 '=back',
855 <<'EOD',
856This method should be used by DBIx::Class extension authors, to determine the
857version of modules a specific feature requires in the B<current> version of
858DBIx::Class. See the L</SYNOPSIS> for a real-world
859example.
860EOD
861
862 '=head2 req_ok_for',
863 '=over',
864 '=item Arguments: $group_name',
865 '=item Return Value: 1|0',
866 '=back',
867 <<'EOD',
868Returns true or false depending on whether all modules required by
869C<$group_name> are present on the system and loadable.
870EOD
871
872 '=head2 req_missing_for',
873 '=over',
874 '=item Arguments: $group_name',
875 '=item Return Value: $error_message_string',
876 '=back',
877 <<"EOD",
878Returns a single line string suitable for inclusion in larger error messages.
879This method would normally be used by DBIx::Class core-module author, to
880indicate to the user that he needs to install specific modules before he will
881be able to use a specific feature.
882
883For example if some of the requirements for C<deploy> are not available,
884the returned string could look like:
885
886 SQL::Translator >= $sqltver (see $class for details)
887
888The author is expected to prepend the necessary text to this message before
889returning the actual error seen by the user.
890EOD
891
892 '=head2 die_unless_req_ok_for',
893 '=over',
894 '=item Arguments: $group_name',
895 '=back',
896 <<'EOD',
897Checks if L</req_ok_for> passes for the supplied C<$group_name>, and
898in case of failure throws an exception including the information
899from L</req_missing_for>.
900EOD
901
902 '=head2 req_errorlist_for',
903 '=over',
904 '=item Arguments: $group_name',
905 '=item Return Value: \%list_of_loaderrors_per_module',
906 '=back',
907 <<'EOD',
908Returns a hashref containing the actual errors that occurred while attempting
909to load each module in the requirement group.
910EOD
911 '=head1 FURTHER QUESTIONS?',
912 'Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.',
913 '=head1 COPYRIGHT AND LICENSE',
914 <<'EOL',
915This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
916by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
917redistribute it and/or modify it under the same terms as the
918L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
919EOL
920
921 );
922
923 open (my $fh, '>', $podfn) or Carp::croak "Unable to write to $podfn: $!";
924 print $fh join ("\n\n", @chunks);
925 print $fh "\n";
926 close ($fh);
927}
928
929141µs1;
Report produced by the NYTProf 6.02 Perl profiler, developed by Tim Bunce and Adam Kaplan.