The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

SLOYD / Alt-Data-Frame-ButMore-0.004_002 / lib / Test2 / Tools / DataFrame.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
—
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

              
package Test2::Tools::DataFrame;
# ABSTRACT: Tools for verifying Data::Frame data frames
use 5.010;
use strict;
use warnings;
our $VERSION = '0.004_002'; # TRIAL VERSION
use Safe::Isa;
use Test2::API qw/context/;
use Test2::Util::Table qw/table/;
use Test2::Util::Ref qw/render_ref/;
use parent qw/Exporter/;
our @EXPORT = qw(dataframe_ok dataframe_is);
sub dataframe_ok ($;$) {
    my ( $thing, $name ) = @_;
    my $ctx = context();
    unless ( $thing->$_DOES('Data::Frame') ) {
        my $thingname = render_ref($thing);
        $ctx->ok( 0, $name, ["'$thingname' is not a data frame object."] );
        $ctx->release;
        return 0;
    }
    $ctx->ok( 1, $name );
    $ctx->release;
    return 1;
}
sub dataframe_is ($$;$@) {
    my ( $got, $exp, $name, @diag ) = @_;
    my $ctx = context();
    # TODO: Make this a package variable.
    local $Data::Frame::TOLERANCE_REL = 1e-9;
    unless ( $got->$_DOES('Data::Frame') ) {
        my $gotname = render_ref($got);
        $ctx->ok( 0, $name,
            ["First argument '$gotname' is not a data frame object."] );
        $ctx->release;
        return 0;
    }
    unless ( $exp->$_DOES('Data::Frame') ) {
        my $expname = render_ref($exp);
        $ctx->ok( 0, $name,
            ["Second argument '$expname' is not a data frame object."] );
        $ctx->release;
        return 0;
    }
    my $diff;
    eval { $diff = ( $got != $exp ); };
    if ($@) {
        my $gotname = render_ref($got);
        $ctx->ok( 0, $name, [ "'$gotname' is different from expected.", $@ ],
            @diag );
        $ctx->release;
        return 0;
    }
    my $diff_which = $diff->which( bad_to_val => 1 );
    unless ( $diff_which->isempty ) {
        my $gotname      = render_ref($got);
        my $column_names = $exp->column_names;
        my @table        = table(
            sanitize  => 1,
            max_width => 80,
            collapse  => 1,
            header    => [qw(ROWIDX COLUMN GOT CHECK)],
            rows      => [
                map {
                    my ( $ridx, $cidx ) = @$_;
                    [
                        $ridx, $column_names->[$cidx],
                        $got->at( $ridx, $cidx ), $exp->at( $ridx, $cidx )
                    ]
                } @{ $diff_which->unpdl }
            ]
        );
        $ctx->ok( 0, $name,
            [ "'$gotname' is different from expected.", @table ], @diag );
        $ctx->release;
        return 0;
    }
    $ctx->ok( 1, $name );
    $ctx->release;
    return 1;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Test2::Tools::DataFrame - Tools for verifying Data::Frame data frames
=head1 VERSION
version 0.004_002
=head1 SYNOPSIS
    use Test2::Tools::DataFrame;
    # Functions are exported by default.
     
    # Ensure something is a data frame.
    dataframe_ok($df);
    # Compare two data frames.
    dataframe_is($got, $expected, 'Same data frame.');
=head1 FUNCTIONS
=head2 dataframe_ok($thing, $name)
Checks that the given C<$thing> is a L<Data::Frame> object.
=head2 dataframe_is($got, $exp, $name);
Checks that data frame C<$got> is same as C<$exp>.
=head1 DESCRIPTION 
This module contains tools for verifying L<Data::Frame> data frame
objects.
=head1 SEE ALSO
L<Data::Frame>,
L<Test2::Suite> 
=head1 AUTHORS
=over 4
=item *
Zakariyya Mughal <zmughal@cpan.org>
=item *
Stephan Loyd <sloyd@cpan.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2014, 2019 by Zakariyya Mughal, Stephan Loyd.
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