summaryrefslogtreecommitdiff
path: root/cpan/Test-Simple/lib/Test/MostlyLike.pm
diff options
context:
space:
mode:
Diffstat (limited to 'cpan/Test-Simple/lib/Test/MostlyLike.pm')
-rw-r--r--cpan/Test-Simple/lib/Test/MostlyLike.pm293
1 files changed, 0 insertions, 293 deletions
diff --git a/cpan/Test-Simple/lib/Test/MostlyLike.pm b/cpan/Test-Simple/lib/Test/MostlyLike.pm
deleted file mode 100644
index 88316094a9..0000000000
--- a/cpan/Test-Simple/lib/Test/MostlyLike.pm
+++ /dev/null
@@ -1,293 +0,0 @@
-package Test::MostlyLike;
-use strict;
-use warnings;
-
-use Test::Stream::Toolset;
-use Test::Stream::Exporter;
-default_exports qw/mostly_like/;
-Test::Stream::Exporter->cleanup;
-
-use Test::More::DeepCheck::Tolerant;
-
-sub mostly_like {
- my ($got, $want, $name) = @_;
-
- my $ctx = context();
-
- unless( @_ == 2 or @_ == 3 ) {
- my $msg = <<'WARNING';
-mostly_like() takes two or three args, you gave %d.
-This usually means you passed an array or hash instead
-of a reference to it
-WARNING
- chop $msg; # clip off newline so carp() will put in line/file
-
- $ctx->alert(sprintf $msg, scalar @_);
-
- $ctx->ok(0, undef, ['incorrect number of args']);
- return 0;
- }
-
- my ($ok, @diag) = Test::More::DeepCheck::Tolerant->check($got, $want);
- $ctx->ok($ok, $name, \@diag);
- return $ok;
-}
-
-1;
-
-__END__
-=pod
-
-=encoding UTF-8
-
-=head1 NAME
-
-Test::MostlyLike - Relaxed checking of deep data structures.
-
-=head1 SYNOPSYS
-
- my $got = [qw/foo bar baz/];
-
- mostly_like(
- $got,
- ['foo', qr/a/],
- "Deeply nested structure matches (mostly)"
- );
-
-=head1 DESCRIPTION
-
-A tool based on C<is_deeply> from L<Test::More>. This tool produces nearly
-identical diagnostics. This tool gives you extra control by letting you check
-only the parts of the structure you care about, ignoring the rest.
-
-=head1 EXPORTS
-
-=over 4
-
-=item $bool = mostly_like($got, $expect, $name)
-
-Generates a single ok event with diagnostics to help you find any failures.
-
-Got should be the data structure you want to test. $expect should be a data
-structure representing what you expect to see. Unlike C<is_deeply> any keys in
-C<$got> that do not I<exist> in C<$expect> will be ignored.
-
-=back
-
-=head1 WHAT TO EXPECT
-
-When an a blessed object is encountered in the C<$got> structure, any fields
-listed in C<$expect> will be called as methods on the C<$got> object. See the
-object/direct element access section below for bypassing this.
-
-Any keys or attributes in C<$got> will be ignored unless the also I<exist> in C<$expect>
-
-=head1 IGNORING THINGS YOU DO NOT CARE ABOUT
-
- my $got = { foo => 1, bar => 2 };
- my $expect = { foo => 1 };
-
- mostly_like($got, $expect, "Ignores 'bar'");
-
-If you want to check that a value is not set:
-
- my $got = { foo => 1, bar => 2 };
- my $expect = { foo => 1, bar => undef };
-
- mostly_like($got, $expect, "Will fail since 'bar' has a value");
-
-=head2 EXACT MATCHES
-
- my $got = 'foo';
- my $expect = 'foo';
- mostly_like($got, $expect, "Check a value directly");
-
-Also works for deeply nested structures
-
- mostly_like(
- [
- {stuff => 'foo bar baz'},
- ],
- [
- {stuff => 'foo bar baz'},
- ],
- "Check a value directly, nested"
- );
-
-=head2 REGEX MATCHES
-
- my $got = 'foo bar baz';
- my $expect = qr/bar/;
- mostly_like($got, $expect, 'Match');
-
-Works nested as well:
-
- mostly_like(
- [
- {stuff => 'foo bar baz'},
- ],
- [
- {stuff => qr/bar/},
- ],
- "Check a value directly, nested"
- );
-
-=head2 ARRAY ELEMENT MATCHES
-
- my $got = [qw/foo bar baz/];
- my $exp = [qw/foo bar/];
-
- mostly_like($got, $exp, "Ignores unspecified indexes");
-
-You can also just check specific indexes:
-
- my $got = [qw/foo bar baz/];
- my $exp = { ':1' => 'bar' };
-
- mostly_like($got, $exp, "Only checks array index 1");
-
-When doing this the index must always be prefixed with ':'.
-
-=head2 HASH ELEMENT MATCHES
-
- my $got = { foo => 1, bar => 2 };
- my $exp = { foo => 1 };
-
- mostly_like($got, $exp, "Only checks foo");
-
-=head2 OBJECT METHOD MATCHES
-
-=head3 UNALTERED
-
- sub foo { $_[0]->{foo} }
-
- my $got = bless {foo => 1}, __PACKAGE__;
- my $exp = { foo => 1 };
-
- mostly_like($got, $exp, 'Checks the return of $got->foo()');
-
-=head3 WRAPPED
-
-Sometimes methods return lists, in such cases you can wrap them in arrayrefs or
-hashrefs:
-
- sub list { qw/foo bar baz/ }
- sub dict { foo => 0, bar => 1, baz => 2 }
-
- my $got = bless {}, __PACKAGE__;
- my $exp = {
- '[list]' => [ qw/foo bar baz/ ],
- '[dict]' => { foo => 0, bar => 1, baz => 2 },
- };
- mostly_like($got, $exp, "Wrapped the method calls");
-
-=head3 DIRECT ELEMENT ACCESS
-
-Sometimes you want to ignore the methods and get the hash value directly.
-
- sub foo { die "do not call me" }
-
- my $got = bless { foo => 'secret' }, __PACKAGE__;
- my $exp = { ':foo' => 'secret' };
-
- mostly_like($got, $exp, "Did not call the fatal method");
-
-=head1 SOURCE
-
-The source code repository for Test::More can be found at
-F<http://github.com/Test-More/test-more/>.
-
-=head1 MAINTAINER
-
-=over 4
-
-=item Chad Granum E<lt>exodist@cpan.orgE<gt>
-
-=back
-
-=head1 AUTHORS
-
-The following people have all contributed to the Test-More dist (sorted using
-VIM's sort function).
-
-=over 4
-
-=item Chad Granum E<lt>exodist@cpan.orgE<gt>
-
-=item Fergal Daly E<lt>fergal@esatclear.ie>E<gt>
-
-=item Mark Fowler E<lt>mark@twoshortplanks.comE<gt>
-
-=item Michael G Schwern E<lt>schwern@pobox.comE<gt>
-
-=item 唐鳳
-
-=back
-
-=head1 COPYRIGHT
-
-There has been a lot of code migration between modules,
-here are all the original copyrights together:
-
-=over 4
-
-=item Test::Stream
-
-=item Test::Stream::Tester
-
-=item Test::MostlyLike
-
-Copyright 2014 Chad Granum E<lt>exodist7@gmail.comE<gt>.
-
-This program is free software; you can redistribute it and/or
-modify it under the same terms as Perl itself.
-
-See F<http://www.perl.com/perl/misc/Artistic.html>
-
-=item Test::Simple
-
-=item Test::More
-
-=item Test::Builder
-
-Originally authored by Michael G Schwern E<lt>schwern@pobox.comE<gt> with much
-inspiration from Joshua Pritikin's Test module and lots of help from Barrie
-Slaymaker, Tony Bowden, blackstar.co.uk, chromatic, Fergal Daly and the perl-qa
-gang.
-
-Idea by Tony Bowden and Paul Johnson, code by Michael G Schwern
-E<lt>schwern@pobox.comE<gt>, wardrobe by Calvin Klein.
-
-Copyright 2001-2008 by Michael G Schwern E<lt>schwern@pobox.comE<gt>.
-
-This program is free software; you can redistribute it and/or
-modify it under the same terms as Perl itself.
-
-See F<http://www.perl.com/perl/misc/Artistic.html>
-
-=item Test::use::ok
-
-To the extent possible under law, 唐鳳 has waived all copyright and related
-or neighboring rights to L<Test-use-ok>.
-
-This work is published from Taiwan.
-
-L<http://creativecommons.org/publicdomain/zero/1.0>
-
-=item Test::Tester
-
-This module is copyright 2005 Fergal Daly <fergal@esatclear.ie>, some parts
-are based on other people's work.
-
-Under the same license as Perl itself
-
-See http://www.perl.com/perl/misc/Artistic.html
-
-=item Test::Builder::Tester
-
-Copyright Mark Fowler E<lt>mark@twoshortplanks.comE<gt> 2002, 2004.
-
-This program is free software; you can redistribute it
-and/or modify it under the same terms as Perl itself.
-
-=back
View Lorry Controller Status