File Coverage

blib/lib/Test/Structures/Data.pm

Criterion	Covered	Total	%
statement	29	29	100.0
branch	2	2	100.0
condition	1	2	50.0
subroutine	8	8	100.0
pod	1	1	100.0
total	41	42	97.6

#############
# Created By: setitesuk
# Created On: 2010-04-20

package Test::Structures::Data;
use strict;
use warnings;
use Carp;
use English qw{-no_match_vars};
use Readonly; Readonly::Scalar our $VERSION => 0.025;

use base qw{Exporter};
our @EXPORT = qw{is_value_found_in_hash_values}; ## no critic (Modules::ProhibitAutomaticExportation)

use Test::Builder;

my $test = Test::Builder->new();

=head1 NAME

Test::Structures::Data

=head1 VERSION

$LastChangedRevision$

=head1 SYNOPSIS

  use Test::More tests => 21;
  use Test::Structures::Data;

  is_value_found_in_hash_values( $value, $href, $optional_description );

=head1 DESCRIPTION

This module gives additional tests created by Test::Builder which will test data structures. Currently only one is available,
however more are planned.

=head1 SUBROUTINES/METHODS

=head2 is_value_found_in_hash_values

exported by default. This test checks to see if the value you provide is within the values of the hashref also provided as the second arguement.

  is_value_found_in_hash_values( $value, $href, $optional_description );

=cut

sub is_value_found_in_hash_values {
  my ( $value, $hash, $desc ) = @_;

  my $result;

  foreach my $key ( keys %{ $hash } ) {
    if ( $value eq $hash->{$key} ) {
      $result = 1;
      last;
    }
  }

  return $test->ok( $result, $desc ) || $test->diag( "$value not found in hash $hash" );
}

1;
__END__