Initial Commit

database/perl/vendor/lib/Test2/Bundle/Extended.pm

@@ -0,0 +1,481 @@
+package Test2::Bundle::Extended;
+use strict;
+use warnings;
+
+use Test2::V0;
+
+our $VERSION = '0.000139';
+
+BEGIN {
+    push @Test2::Bundle::Extended::ISA => 'Test2::V0';
+    no warnings 'once';
+    *EXPORT = \@Test2::V0::EXPORT;
+}
+
+our %EXPORT_TAGS = (
+    'v1' => \@Test2::Bundle::Extended::EXPORT,
+);
+
+1;
+
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+Test2::Bundle::Extended - Old name for Test2::V0
+
+=head1 *** DEPRECATED ***
+
+This bundle has been renamed to L<Test2::V0>, in which the C<':v1'> tag has
+been removed as unnecessary.
+
+=head1 DESCRIPTION
+
+This is the big-daddy bundle. This bundle includes nearly every tool, and
+several plugins, that the Test2 author uses. This bundle is used
+extensively to test L<Test2::Suite> itself.
+
+=head1 SYNOPSIS
+
+    use Test2::Bundle::Extended ':v1';
+
+    ok(1, "pass");
+
+    ...
+
+    done_testing;
+
+=head1 RESOLVING CONFLICTS WITH MOOSE
+
+    use Test2::Bundle::Extended '!meta';
+
+L<Moose> and L<Test2::Bundle::Extended> both export very different C<meta()>
+subs. Adding C<'!meta'> to the import args will prevent the sub from being
+imported. This bundle also exports the sub under the name C<meta_check()> so
+you can use that spelling as an alternative.
+
+=head2 TAGS
+
+=over 4
+
+=item :v1
+
+=item :DEFAULT
+
+The following are all identical:
+
+    use Test2::Bundle::Extended;
+
+    use Test2::Bundle::Extended ':v1';
+
+    use Test2::Bundle::Extended ':DEFAULT';
+
+=back
+
+=head2 RENAMING ON IMPORT
+
+    use Test2::Bundle::Extended ':v1', '!ok', ok => {-as => 'my_ok'};
+
+This bundle uses L<Importer> for exporting, as such you can use any arguments
+it accepts.
+
+Explanation:
+
+=over 4
+
+=item ':v1'
+
+Use the default tag, all default exports.
+
+=item '!ok'
+
+Do not export C<ok()>
+
+=item ok => {-as => 'my_ok'}
+
+Actually, go ahead and import C<ok()> but under the name C<my_ok()>.
+
+=back
+
+If you did not add the C<'!ok'> argument then you would have both C<ok()> and
+C<my_ok()>
+
+=head1 PRAGMAS
+
+All of these can be disabled via individual import arguments, or by the
+C<-no_pragmas> argument.
+
+    use Test2::Bundle::Extended -no_pragmas => 1;
+
+=head2 STRICT
+
+L<strict> is turned on for you. You can disable this with the C<-no_strict> or
+C<-no_pragmas> import arguments:
+
+    use Test2::Bundle::Extended -no_strict => 1;
+
+=head2 WARNINGS
+
+L<warnings> are turned on for you. You can disable this with the
+C<-no_warnings> or C<-no_pragmas> import arguments:
+
+    use Test2::Bundle::Extended -no_warnings => 1;
+
+=head2 UTF8
+
+This is actually done via the L<Test2::Plugin::UTF8> plugin, see the
+L</PLUGINS> section for details.
+
+B<Note:> C<< -no_pragmas => 1 >> will turn off the entire plugin.
+
+=head1 PLUGINS
+
+=head2 SRAND
+
+See L<Test2::Plugin::SRand>.
+
+This will set the random seed to today's date. You can provide an alternate seed
+with the C<-srand> import option:
+
+    use Test2::Bundle::Extended -srand => 1234;
+
+=head2 UTF8
+
+See L<Test2::Plugin::UTF8>.
+
+This will set the file, and all output handles (including formatter handles), to
+utf8. This will turn on the utf8 pragma for the current scope.
+
+This can be disabled using the C<< -no_utf8 => 1 >> or C<< -no_pragmas => 1 >>
+import arguments.
+
+    use Test2::Bundle::Extended -no_utf8 => 1;
+
+=head2 EXIT SUMMARY
+
+See L<Test2::Plugin::ExitSummary>.
+
+This plugin has no configuration.
+
+=head1 API FUNCTIONS
+
+See L<Test2::API> for these
+
+=over 4
+
+=item $ctx = context()
+
+=item $events = intercept { ... }
+
+=back
+
+=head1 TOOLS
+
+=head2 TARGET
+
+See L<Test2::Tools::Target>.
+
+You can specify a target class with the C<-target> import argument. If you do
+not provide a target then C<$CLASS> and C<CLASS()> will not be imported.
+
+    use Test2::Bundle::Extended -target => 'My::Class';
+
+    print $CLASS;  # My::Class
+    print CLASS(); # My::Class
+
+Or you can specify names:
+
+    use Test2::Bundle::Extended -target => { pkg => 'Some::Package' };
+
+    pkg()->xxx; # Call 'xxx' on Some::Package
+    $pkg->xxx;  # Same
+
+=over 4
+
+=item $CLASS
+
+Package variable that contains the target class name.
+
+=item $class = CLASS()
+
+Constant function that returns the target class name.
+
+=back
+
+=head2 DEFER
+
+See L<Test2::Tools::Defer>.
+
+=over 4
+
+=item def $func => @args;
+
+=item do_def()
+
+=back
+
+=head2 BASIC
+
+See L<Test2::Tools::Basic>.
+
+=over 4
+
+=item ok($bool, $name)
+
+=item pass($name)
+
+=item fail($name)
+
+=item diag($message)
+
+=item note($message)
+
+=item $todo = todo($reason)
+
+=item todo $reason => sub { ... }
+
+=item skip($reason, $count)
+
+=item plan($count)
+
+=item skip_all($reason)
+
+=item done_testing()
+
+=item bail_out($reason)
+
+=back
+
+=head2 COMPARE
+
+See L<Test2::Tools::Compare>.
+
+=over 4
+
+=item is($got, $want, $name)
+
+=item isnt($got, $do_not_want, $name)
+
+=item like($got, qr/match/, $name)
+
+=item unlike($got, qr/mismatch/, $name)
+
+=item $check = match(qr/pattern/)
+
+=item $check = mismatch(qr/pattern/)
+
+=item $check = validator(sub { return $bool })
+
+=item $check = hash { ... }
+
+=item $check = array { ... }
+
+=item $check = bag { ... }
+
+=item $check = object { ... }
+
+=item $check = meta { ... }
+
+=item $check = number($num)
+
+=item $check = string($str)
+
+=item $check = check_isa($class_name)
+
+=item $check = in_set(@things)
+
+=item $check = not_in_set(@things)
+
+=item $check = check_set(@things)
+
+=item $check = item($thing)
+
+=item $check = item($idx => $thing)
+
+=item $check = field($name => $val)
+
+=item $check = call($method => $expect)
+
+=item $check = call_list($method => $expect)
+
+=item $check = call_hash($method => $expect)
+
+=item $check = prop($name => $expect)
+
+=item $check = check($thing)
+
+=item $check = T()
+
+=item $check = F()
+
+=item $check = D()
+
+=item $check = DF()
+
+=item $check = DNE()
+
+=item $check = FDNE()
+
+=item $check = exact_ref($ref)
+
+=item end()
+
+=item etc()
+
+=item filter_items { grep { ... } @_ }
+
+=item $check = event $type => ...
+
+=item @checks = fail_events $type => ...
+
+=back
+
+=head2 CLASSIC COMPARE
+
+See L<Test2::Tools::ClassicCompare>.
+
+=over 4
+
+=item cmp_ok($got, $op, $want, $name)
+
+=back
+
+=head2 SUBTEST
+
+See L<Test2::Tools::Subtest>.
+
+=over 4
+
+=item subtest $name => sub { ... }
+
+(Note: This is called C<subtest_buffered()> in the Tools module.)
+
+=back
+
+=head2 CLASS
+
+See L<Test2::Tools::Class>.
+
+=over 4
+
+=item can_ok($thing, @methods)
+
+=item isa_ok($thing, @classes)
+
+=item DOES_ok($thing, @roles)
+
+=back
+
+=head2 ENCODING
+
+See L<Test2::Tools::Encoding>.
+
+=over 4
+
+=item set_encoding($encoding)
+
+=back
+
+=head2 EXPORTS
+
+See L<Test2::Tools::Exports>.
+
+=over 4
+
+=item imported_ok('function', '$scalar', ...)
+
+=item not_imported_ok('function', '$scalar', ...)
+
+=back
+
+=head2 REF
+
+See L<Test2::Tools::Ref>.
+
+=over 4
+
+=item ref_ok($ref, $type)
+
+=item ref_is($got, $want)
+
+=item ref_is_not($got, $do_not_want)
+
+=back
+
+=head2 MOCK
+
+See L<Test2::Tools::Mock>.
+
+=over 4
+
+=item $control = mock ...
+
+=item $bool = mocked($thing)
+
+=back
+
+=head2 EXCEPTION
+
+See L<Test2::Tools::Exception>.
+
+=over 4
+
+=item $exception = dies { ... }
+
+=item $bool = lives { ... }
+
+=item $bool = try_ok { ... }
+
+=back
+
+=head2 WARNINGS
+
+See L<Test2::Tools::Warnings>.
+
+=over 4
+
+=item $count = warns { ... }
+
+=item $warning = warning { ... }
+
+=item $warnings_ref = warnings { ... }
+
+=item $bool = no_warnings { ... }
+
+=back
+
+=head1 SOURCE
+
+The source code repository for Test2-Suite can be found at
+F<https://github.com/Test-More/Test2-Suite/>.
+
+=head1 MAINTAINERS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 AUTHORS
+
+=over 4
+
+=item Chad Granum E<lt>exodist@cpan.orgE<gt>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2018 Chad Granum E<lt>exodist@cpan.orgE<gt>.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
+
+See F<http://dev.perl.org/licenses/>
+
+=cut