File Coverage

blib/lib/List/Objects/WithUtils/Role/Hash/Typed.pm

Criterion	Covered	Total	%
statement	15	15	100.0
branch			n/a
condition			n/a
subroutine	5	5	100.0
pod			n/a
total	20	20	100.0

package List::Objects::WithUtils::Role::Hash::Typed;
$List::Objects::WithUtils::Role::Hash::Typed::VERSION = '2.028003';
use strictures 2;

use Carp ();
use Scalar::Util ();
use Type::Tie ();

use Role::Tiny;
requires 'type', 'untyped', 'new';

around type => sub { tied(%{$_[1]})->type };

around untyped => sub {
  my (undef, $self) = @_;
  require List::Objects::WithUtils::Hash;
  List::Objects::WithUtils::Hash->new(%$self)
};

around new => sub {
  my (undef, $class, $type) = splice @_, 0, 2;

  if (my $blessed = Scalar::Util::blessed $class) {
    $type  = $class->type;
    $class = $blessed;
  } else {
    $type = shift;
  }

  my $self = +{};
  tie %$self, 'Type::Tie::HASH', $type;
  %$self = @_;
  bless $self, $class;
};

1;

=pod

=for Pod::Coverage new hash_of

=head1 NAME

List::Objects::WithUtils::Role::Hash::Typed - Type-checking hash behavior

=head1 SYNOPSIS

  # Via List::Objects::WithUtils::Hash::Typed ->
  use List::Objects::WithUtils 'hash_of';
  use Types::Standard -all;

  my $arr = hash_of(Int, foo => 1, bar => 2);
  $arr->set(baz => 3.14159);    # dies, failed type check

=head1 DESCRIPTION

This role makes use of L to add type-checking behavior to
L consumers.

The first argument passed to the constructor should be a L type
(or other object conforming to L, as of C):

  use Types::Standard -all;
  my $arr = hash_of ArrayRef() => (foo => [], bar => []);

Values are checked against the specified type when the object is constructed
or new elements are added.

If the initial type-check fails, a coercion is attempted.

Values that cannot be coerced will throw an exception.

Also see L, L

=head2 type

Returns the L type the object was created with.

=head2 untyped

Returns a (shallow) clone that is a plain L.

=head1 AUTHOR

Jon Portnoy ; typed hashes implemented by Toby Inkster
(CPAN: TOBYINK)

=cut