.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test::Data::Scalar 3pm"
.TH Test::Data::Scalar 3pm 2024-03-16 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Test::Data::Scalar \-\- test functions for scalar variables
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&        use Test::Data qw(Scalar);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This modules provides a collection of test utilities for
scalar variables.  Load the module through Test::Data.
.SS Functions
.IX Subsection "Functions"
.IP "blessed_ok( SCALAR )" 4
.IX Item "blessed_ok( SCALAR )"
Ok if the SCALAR is a blessed reference.
.IP "defined_ok( SCALAR )" 4
.IX Item "defined_ok( SCALAR )"
Ok if the SCALAR is defined.
.IP "undef_ok( SCALAR )" 4
.IX Item "undef_ok( SCALAR )"
Ok if the SCALAR is undefined.
.IP "dualvar_ok( SCALAR )" 4
.IX Item "dualvar_ok( SCALAR )"
Ok if the scalar is a dualvar.
.Sp
How do I test this?
.IP "greater_than( SCALAR, BOUND )" 4
.IX Item "greater_than( SCALAR, BOUND )"
Ok if the SCALAR is numerically greater than BOUND.
.IP "length_ok( SCALAR, LENGTH )" 4
.IX Item "length_ok( SCALAR, LENGTH )"
Ok if the length of SCALAR is LENGTH.
.IP "less_than( SCALAR, BOUND )" 4
.IX Item "less_than( SCALAR, BOUND )"
Ok if the SCALAR is numerically less than BOUND.
.IP "maxlength_ok( SCALAR, LENGTH )" 4
.IX Item "maxlength_ok( SCALAR, LENGTH )"
Ok is the length of SCALAR is less than or equal to LENGTH.
.IP "minlength_ok( SCALAR, LENGTH )" 4
.IX Item "minlength_ok( SCALAR, LENGTH )"
Ok is the length of SCALAR is greater than or equal to LENGTH.
.IP "number_ok( SCALAR )" 4
.IX Item "number_ok( SCALAR )"
Ok if the SCALAR is a number ( or a string that represents a
number ).
.Sp
At the moment, a number is just a string of digits.  This needs
work.
.IP "number_between_ok( SCALAR, LOWER, UPPER )" 4
.IX Item "number_between_ok( SCALAR, LOWER, UPPER )"
Ok if the number in SCALAR sorts between the number
in LOWER and the number in UPPER, numerically.
.Sp
If you put something that isn't a number into UPPER or
LOWER, Perl will try to make it into a number and you
may get unexpected results.
.IP "string_between_ok( SCALAR, LOWER, UPPER )" 4
.IX Item "string_between_ok( SCALAR, LOWER, UPPER )"
Ok if the string in SCALAR sorts between the string
in LOWER and the string in UPPER, ASCII-betically.
.IP "readonly_ok( SCALAR )" 4
.IX Item "readonly_ok( SCALAR )"
Ok is the SCALAR is read-only.
.IP "ref_ok( SCALAR )" 4
.IX Item "ref_ok( SCALAR )"
Ok if the SCALAR is a reference.
.IP "ref_type_ok( REF1, REF2 )" 4
.IX Item "ref_type_ok( REF1, REF2 )"
Ok if REF1 is the same reference type as REF2.
.IP "strong_ok( SCALAR )" 4
.IX Item "strong_ok( SCALAR )"
Ok is the SCALAR is not a weak reference.
.IP "tainted_ok( SCALAR )" 4
.IX Item "tainted_ok( SCALAR )"
Ok is the SCALAR is tainted.
.Sp
(Tainted values may seem like a not-Ok thing, but remember, when
you use taint checking, you want Perl to taint data, so you
should have a test to make sure it happens.)
.IP "untainted_ok( SCALAR )" 4
.IX Item "untainted_ok( SCALAR )"
Ok if the SCALAR is not tainted.
.IP "weak_ok( SCALAR )" 4
.IX Item "weak_ok( SCALAR )"
Ok if the SCALAR is a weak reference.
.SH "TO DO"
.IX Header "TO DO"
* add is_a_filehandle test
.PP
* add is_vstring test
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Scalar::Util,
Test::Data,
Test::Data::Array,
Test::Data::Function,
Test::Data::Hash,
Test::Builder
.SH "SOURCE AVAILABILITY"
.IX Header "SOURCE AVAILABILITY"
This source is in Github:
.PP
.Vb 1
\&        https://github.com/briandfoy/test\-data
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
brian d foy, \f(CW\*(C`<briandfoy@pobox.com>\*(C'\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright © 2002\-2024, brian d foy <briandfoy@pobox.com>. All rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the Artistic License 2.0.