=pod

=encoding utf-8

=head1 PURPOSE

Basic tests for B<Dict> from L<Types::Standard>.

=head1 AUTHOR

Toby Inkster E<lt>tobyink@cpan.orgE<gt>.

=head1 COPYRIGHT AND LICENCE

This software is copyright (c) 2019-2025 by Toby Inkster.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut

use strict;
use warnings;
use Test::More;
use Test::Fatal;
use Test::TypeTiny;
use Test::Requires qw(boolean);
use Types::Standard qw( Dict );

isa_ok(Dict, 'Type::Tiny', 'Dict');
is(Dict->name, 'Dict', 'Dict has correct name');
is(Dict->display_name, 'Dict', 'Dict has correct display_name');
is(Dict->library, 'Types::Standard', 'Dict knows it is in the Types::Standard library');
ok(Types::Standard->has_type('Dict'), 'Types::Standard knows it has type Dict');
ok(!Dict->deprecated, 'Dict is not deprecated');
ok(!Dict->is_anon, 'Dict is not anonymous');
ok(Dict->can_be_inlined, 'Dict can be inlined');
is(exception { Dict->inline_check(q/$xyz/) }, undef, "Inlining Dict doesn't throw an exception");
ok(!Dict->has_coercion, "Dict doesn't have a coercion");
ok(Dict->is_parameterizable, "Dict is parameterizable");
isnt(Dict->type_default, undef, "Dict has a type_default");
is_deeply(Dict->type_default->(), {}, "Dict type_default is {}");

#
# The @tests array is a list of triples:
#
# 1. Expected result - pass, fail, or xxxx (undefined).
# 2. A description of the value being tested.
# 3. The value being tested.
#

my @tests = (
	fail => 'undef'                    => undef,
	fail => 'false'                    => !!0,
	fail => 'true'                     => !!1,
	fail => 'zero'                     =>  0,
	fail => 'one'                      =>  1,
	fail => 'negative one'             => -1,
	fail => 'non integer'              =>  3.1416,
	fail => 'empty string'             => '',
	fail => 'whitespace'               => ' ',
	fail => 'line break'               => "\n",
	fail => 'random string'            => 'abc123',
	fail => 'loaded package name'      => 'Type::Tiny',
	fail => 'unloaded package name'    => 'This::Has::Probably::Not::Been::Loaded',
	fail => 'a reference to undef'     => do { my $x = undef; \$x },
	fail => 'a reference to false'     => do { my $x = !!0; \$x },
	fail => 'a reference to true'      => do { my $x = !!1; \$x },
	fail => 'a reference to zero'      => do { my $x = 0; \$x },
	fail => 'a reference to one'       => do { my $x = 1; \$x },
	fail => 'a reference to empty string' => do { my $x = ''; \$x },
	fail => 'a reference to random string' => do { my $x = 'abc123'; \$x },
	fail => 'blessed scalarref'        => bless(do { my $x = undef; \$x }, 'SomePkg'),
	fail => 'empty arrayref'           => [],
	fail => 'arrayref with one zero'   => [0],
	fail => 'arrayref of integers'     => [1..10],
	fail => 'arrayref of numbers'      => [1..10, 3.1416],
	fail => 'blessed arrayref'         => bless([], 'SomePkg'),
	pass => 'empty hashref'            => {},
	pass => 'hashref'                  => { foo => 1 },
	fail => 'blessed hashref'          => bless({}, 'SomePkg'),
	fail => 'coderef'                  => sub { 1 },
	fail => 'blessed coderef'          => bless(sub { 1 }, 'SomePkg'),
	fail => 'glob'                     => do { no warnings 'once'; *SOMETHING },
	fail => 'globref'                  => do { no warnings 'once'; my $x = *SOMETHING; \$x },
	fail => 'blessed globref'          => bless(do { no warnings 'once'; my $x = *SOMETHING; \$x }, 'SomePkg'),
	fail => 'regexp'                   => qr/./,
	fail => 'blessed regexp'           => bless(qr/./, 'SomePkg'),
	fail => 'filehandle'               => do { open my $x, '<', $0 or die; $x },
	fail => 'filehandle object'        => do { require IO::File; 'IO::File'->new($0, 'r') },
	fail => 'ref to scalarref'         => do { my $x = undef; my $y = \$x; \$y },
	fail => 'ref to arrayref'          => do { my $x = []; \$x },
	fail => 'ref to hashref'           => do { my $x = {}; \$x },
	fail => 'ref to coderef'           => do { my $x = sub { 1 }; \$x },
	fail => 'ref to blessed hashref'   => do { my $x = bless({}, 'SomePkg'); \$x },
	fail => 'object stringifying to ""' => do { package Local::OL::StringEmpty; use overload q[""] => sub { "" }; bless [] },
	fail => 'object stringifying to "1"' => do { package Local::OL::StringOne; use overload q[""] => sub { "1" }; bless [] },
	fail => 'object numifying to 0'    => do { package Local::OL::NumZero; use overload q[0+] => sub { 0 }; bless [] },
	fail => 'object numifying to 1'    => do { package Local::OL::NumOne; use overload q[0+] => sub { 1 }; bless [] },
	fail => 'object overloading arrayref' => do { package Local::OL::Array; use overload q[@{}] => sub { $_[0]{array} }; bless {array=>[]} },
	fail => 'object overloading hashref' => do { package Local::OL::Hash; use overload q[%{}] => sub { $_[0][0] }; bless [{}] },
	fail => 'object overloading coderef' => do { package Local::OL::Code; use overload q[&{}] => sub { $_[0][0] }; bless [sub { 1 }] },
	fail => 'object booling to false'  => do { package Local::OL::BoolFalse; use overload q[bool] => sub { 0 }; bless [] },
	fail => 'object booling to true'   => do { package Local::OL::BoolTrue;  use overload q[bool] => sub { 1 }; bless [] },
	fail => 'boolean::false'           => boolean::false,
	fail => 'boolean::true'            => boolean::true,
	fail => 'builtin::false'           => do { no warnings; builtin->can('false') ? builtin::false() : !!0 },
	fail => 'builtin::true'            => do { no warnings; builtin->can('true') ? builtin::true() : !!1 },
#TESTS
);

while (@tests) {
	my ($expect, $label, $value) = splice(@tests, 0 , 3);
	if ($expect eq 'xxxx') {
		note("UNDEFINED OUTCOME: $label");
	}
	elsif ($expect eq 'pass') {
		should_pass($value, Dict, ucfirst("$label should pass Dict"));
	}
	elsif ($expect eq 'fail') {
		should_fail($value, Dict, ucfirst("$label should fail Dict"));
	}
	else {
		fail("expected '$expect'?!");
	}
}

#
# Basic parameterized example
#

my $type1 = Dict[
	foo => Types::Standard::Int,
	bar => Types::Standard::RegexpRef,
];

should_pass( { foo => 42, bar => qr// }, $type1 );
should_fail( { foo => [], bar => qr// }, $type1 );
should_fail( { foo => 42, bar => 1234 }, $type1 );
should_fail( { foo => [], bar => 1234 }, $type1 );
should_fail( { foo => 42              }, $type1 );
should_fail( {            bar => qr// }, $type1 );
should_fail( [ foo => 42, bar => qr// ], $type1 );
should_fail( { foo => 42, bar => qr//, baz => undef }, $type1 );

ok(  $type1->my_hashref_allows_key('bar'),  'my_hashref_allows_key("bar")' );
ok( !$type1->my_hashref_allows_key('baz'), '!my_hashref_allows_key("baz")' );
ok(  $type1->my_hashref_allows_value('bar', qr//),  'my_hashref_allows_value("bar", qr//)' );
ok( !$type1->my_hashref_allows_value('bar', 1234), '!my_hashref_allows_value("bar", 1234)' );

is($type1->type_default, undef, "$type1 has no type_default");


#
# Optional parameterized example
#

use Types::Standard qw( Optional );

# this is mostly the same as $type1...
my $type2 = Dict[
	foo => Types::Standard::Int,
	bar => Optional[ Types::Standard::RegexpRef ],
];

should_pass( { foo => 42, bar => qr// }, $type2 );
should_fail( { foo => [], bar => qr// }, $type2 );
should_fail( { foo => 42, bar => 1234 }, $type2 );
should_fail( { foo => [], bar => 1234 }, $type2 );
should_pass( { foo => 42              }, $type2 );  # this fails with $type1
should_fail( {            bar => qr// }, $type2 );
should_fail( [ foo => 42, bar => qr// ], $type2 );
should_fail( { foo => 42, bar => qr//, baz => undef }, $type2 );

ok(  $type2->my_hashref_allows_key('bar'),  'my_hashref_allows_key("bar")' );
ok( !$type2->my_hashref_allows_key('baz'), '!my_hashref_allows_key("baz")' );
ok(  $type2->my_hashref_allows_value('bar', qr//),  'my_hashref_allows_value("bar", qr//)' );
ok( !$type2->my_hashref_allows_value('bar', 1234), '!my_hashref_allows_value("bar", 1234)' );


#
# Example with Slurpy
#

use Types::Standard qw( Slurpy Map );

my $type3 = Dict[
	foo => Types::Standard::Int,
	bar => Types::Standard::RegexpRef,
	()  => Slurpy[ Map[ Types::Standard::Int, Types::Standard::ArrayRef ] ],
];

should_pass( { foo => 42, bar => qr// }, $type3 );
should_fail( { foo => [], bar => qr// }, $type3 );
should_fail( { foo => 42, bar => 1234 }, $type3 );
should_fail( { foo => [], bar => 1234 }, $type3 );
should_fail( { foo => 42              }, $type3 );
should_fail( {            bar => qr// }, $type3 );
should_fail( [ foo => 42, bar => qr// ], $type3 );
should_fail( { foo => 42, bar => qr//, baz => undef }, $type3 );
should_pass( { foo => 42, bar => qr//, 123 => [] }, $type3 );
should_pass( { foo => 42, bar => qr//, 123 => [], 456 => [] }, $type3 );
should_fail( { foo => 42, bar => qr//, 123 => qr// }, $type3 );
should_fail( { foo => 42, bar => qr//, 123 => qr//, 456 => [] }, $type3 );

ok(  $type3->my_hashref_allows_key('bar'),  'my_hashref_allows_key("bar")' );
ok( !$type3->my_hashref_allows_key('baz'), '!my_hashref_allows_key("baz")' );
ok(  $type3->my_hashref_allows_value('bar', qr//),  'my_hashref_allows_value("bar", qr//)' );
ok( !$type3->my_hashref_allows_value('bar', 1234), '!my_hashref_allows_value("bar", 1234)' );
ok(  $type3->my_hashref_allows_key('123'),  'my_hashref_allows_key("123")' );
ok(  $type3->my_hashref_allows_value('123', []),  'my_hashref_allows_value("123", [])' );
ok( !$type3->my_hashref_allows_value('123', qr//),  '!my_hashref_allows_value("123", qr//)' );


#
# Example with slurpy and Optional
#

my $type4 = Dict[
	foo => Types::Standard::Int->where(sub { $_ % 2 == 0 }),
	bar => Optional[ Types::Standard::RegexpRef ],
	()  => Slurpy[ Map[ Types::Standard::Int, Types::Standard::ArrayRef ] ],
];

should_pass( { foo => 42, bar => qr// }, $type4 );
should_fail( { foo => 41, bar => qr// }, $type4 );
should_fail( { foo => [], bar => qr// }, $type4 );
should_fail( { foo => 42, bar => 1234 }, $type4 );
should_fail( { foo => [], bar => 1234 }, $type4 );
should_pass( { foo => 42              }, $type4 );  # this fails with $type3
should_fail( {            bar => qr// }, $type4 );
should_fail( [ foo => 42, bar => qr// ], $type4 );
should_fail( { foo => 42, bar => qr//, baz => undef }, $type4 );
should_pass( { foo => 42, bar => qr//, 123 => [] }, $type4 );
should_pass( { foo => 42, bar => qr//, 123 => [], 456 => [] }, $type4 );
should_fail( { foo => 42, bar => qr//, 123 => qr// }, $type4 );
should_fail( { foo => 42, bar => qr//, 123 => qr//, 456 => [] }, $type4 );

ok(  $type4->my_hashref_allows_key('bar'),  'my_hashref_allows_key("bar")' );
ok( !$type4->my_hashref_allows_key('baz'), '!my_hashref_allows_key("baz")' );
ok(  $type4->my_hashref_allows_value('bar', qr//),  'my_hashref_allows_value("bar", qr//)' );
ok( !$type4->my_hashref_allows_value('bar', 1234), '!my_hashref_allows_value("bar", 1234)' );
ok(  $type4->my_hashref_allows_key('123'),  'my_hashref_allows_key("123")' );
ok(  $type4->my_hashref_allows_value('123', []),  'my_hashref_allows_value("123", [])' );
ok( !$type4->my_hashref_allows_value('123', qr//),  '!my_hashref_allows_value("123", qr//)' );
ok(  $type4->my_hashref_allows_value('foo', 20), 'my_hashref_allows_value("foo", 20)' );
ok( !$type4->my_hashref_allows_value('foo', 21), '!my_hashref_allows_value("foo", 21)' );

#
# Simple deep coercion
#

my $Rounded = Types::Standard::Int->plus_coercions(
	Types::Standard::Num, q{ int($_) }
);
my $type5 = Dict[foo => $Rounded];

is_deeply(
	$type5->coerce({ foo => 4.1 }),
	{ foo => 4 },
	'deep coercion',
);

is_deeply(
	$type5->coerce({ foo => 4.1, bar => 'xyz' }),
	{ foo => 4.1, bar => 'xyz' },
	'cowardly refuses to drop keys to allow coercion to work',
);


#
# Deep coercion with Optional
#

my $type6 = Dict[
	foo => $Rounded,
	bar => Optional[$Rounded],
];

is_deeply(
	$type6->coerce({ foo => 4.1 }),
	{ foo => 4 },
	'deep coercion',
);

is_deeply(
	$type6->coerce({ foo => 4.1, bar => 5.1 }),
	{ foo => 4, bar => 5 },
	'can coerce optional slots',
);

is_deeply(
	$type6->coerce({ foo => 4.1, bar => 'xyz' }),
	{ foo => 4.1, bar => 'xyz' },
	'cowardly refuses to drop keys to allow coercion to work',
);


#
# Deep coercion with slurpy
#

my $type7 = Dict[
	foo => $Rounded,
	bar => Optional[$Rounded],
	()  => Slurpy[ Types::Standard::HashRef[$Rounded] ],
];

is_deeply(
	$type7->coerce({ foo => 4.1 }),
	{ foo => 4 },
	'deep coercion',
);

is_deeply(
	$type7->coerce({ foo => 4.1, bar => 5.1 }),
	{ foo => 4, bar => 5 },
	'can coerce optional slots',
);

is_deeply(
	$type7->coerce({ foo => 4.1, quux => 6.1 }),
	{ foo => 4, quux => 6 },
	'can coerce slurpy',
);

is_deeply(
	$type7->coerce({ foo => 4.1, bar => 'xyz' }),
	{ foo => 4.1, bar => 'xyz' },
	'cowardly refuses to drop keys to allow coercion to work',
);


#
# Deep coercion with CHILD OF slurpy
#

my $type8 = Dict[
	foo => $Rounded,
	bar => Optional[$Rounded],
	()  => ( Slurpy[ Types::Standard::HashRef[$Rounded] ] )->where( 1 )->where( 1 ),
];

is_deeply(
	$type8->coerce({ foo => 4.1 }),
	{ foo => 4 },
	'deep coercion',
);

is_deeply(
	$type8->coerce({ foo => 4.1, bar => 5.1 }),
	{ foo => 4, bar => 5 },
	'can coerce optional slots',
);

is_deeply(
	$type8->coerce({ foo => 4.1, quux => 6.1 }),
	{ foo => 4, quux => 6 },
	'can coerce slurpy',
);

is_deeply(
	$type8->coerce({ foo => 4.1, bar => 'xyz' }),
	{ foo => 4.1, bar => 'xyz' },
	'cowardly refuses to drop keys to allow coercion to work',
);

# Combine Dicts

my $combined = Types::Standard::Dict::combine(
	Dict[ name => Types::Standard::Str ],
	Dict[ age => Types::Standard::Int, Types::Standard::Slurpy[Types::Standard::HashRef[Types::Standard::Int]] ],
	Dict[ id => Types::Standard::Str, name => Types::Standard::ArrayRef, Types::Standard::Slurpy[Types::Standard::ArrayRef] ],
	Dict[],
)->create_child_type( display_name => 'CombinedDetails' );

ok( $combined->is_a_type_of( Dict ) );
should_pass( { name => 'X', age => 1, id => 'ABC', foo => 1 }, $combined );
should_pass( { name => [ 'X' ], age => 1, id => 'ABC', foo => 1 }, $combined );
should_fail( { name => 'X', age => [ 1 ], id => 'ABC', foo => 1 }, $combined );

my $combined2 = Types::Standard::Dict::combine(
	Dict[ name => Types::Standard::Str ],
	Dict[ name => Types::Standard::Str ],
);

is( $combined2->display_name, 'Dict[name=>Str]' );

my $combined3 = Types::Standard::Dict::combine(
	Dict[ name => Types::Standard::Str ],
	Dict[ name => Types::Standard::Int ],
);

is( $combined3->display_name, 'Dict[name=>Str|Int]' );

done_testing;

