Scalar-Classify
view release on metacpan or search on metacpan
# This Build.PL for Scalar-Classify was generated by Dist::Zilla::Plugin::ModuleBuildTiny 0.015.
use strict;
use warnings;
use 5.008005;
use Module::Build::Tiny 0.034;
Build_PL();
Revision history for Scalar-Classify
0.02 2017-01-16 22:44:18 PST
- Fixed CPAN dependencies
0.01 2016-10-24 18:14:03 PDT
- Initial release
This software is copyright (c) 2016 by Joseph Brenner, <doom@kzsu.stanford.edu>.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
Terms of the Perl programming language system itself
a) the GNU General Public License as published by the Free
Software Foundation; either version 1, or (at your option) any
later version, or
b) the "Artistic License"
--- The GNU General Public License, Version 1, February 1989 ---
This software is Copyright (c) 2016 by Joseph Brenner, <doom@kzsu.stanford.edu>.
This is free software, licensed under:
The GNU General Public License, Version 1, February 1989
GNU GENERAL PUBLIC LICENSE
Version 1, February 1989
Copyright (C) 1989 Free Software Foundation, Inc.
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The license agreements of most software companies try to keep users
at the mercy of those companies. By contrast, our General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. The
General Public License applies to the Free Software Foundation's
software and to any other program whose authors commit to using it.
You can use it for your programs, too.
When we speak of free software, we are referring to freedom, not
price. Specifically, the General Public License is designed to make
sure that you have the freedom to give away or sell copies of free
software, that you receive source code or can get it if you want it,
that you can change the software or use pieces of it in new free
programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of a such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must tell them their rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any program or other work which
contains a notice placed by the copyright holder saying it may be
distributed under the terms of this General Public License. The
"Program", below, refers to any such program or work, and a "work based
on the Program" means either the Program or any work containing the
Program or a portion of it, either verbatim or with modifications. Each
licensee is addressed as "you".
1. You may copy and distribute verbatim copies of the Program's source
code as you receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice and
disclaimer of warranty; keep intact all the notices that refer to this
General Public License and to the absence of any warranty; and give any
other recipients of the Program a copy of this General Public License
along with the Program. You may charge a fee for the physical act of
transferring a copy.
2. You may modify your copy or copies of the Program or any portion of
it, and copy and distribute such modifications under the terms of Paragraph
1 above, provided that you also do the following:
a) cause the modified files to carry prominent notices stating that
you changed the files and the date of any change; and
b) cause the whole of any work that you distribute or publish, that
in whole or in part contains the Program or any part thereof, either
with or without modifications, to be licensed at no charge to all
third parties under the terms of this General Public License (except
that you may choose to grant warranty protection to some or all
third parties, at your option).
c) If the modified program normally reads commands interactively when
run, you must cause it, when started running for such interactive use
in the simplest and most usual way, to print or display an
announcement including an appropriate copyright notice and a notice
that there is no warranty (or else, saying that you provide a
warranty) and that users may redistribute the program under these
conditions, and telling the user how to view a copy of this General
Public License.
d) You may charge a fee for the physical act of transferring a
copy, and you may at your option offer warranty protection in
exchange for a fee.
Mere aggregation of another independent work with the Program (or its
derivative) on a volume of a storage or distribution medium does not bring
the other work under the scope of these terms.
3. You may copy and distribute the Program (or a portion or derivative of
it, under Paragraph 2) in object code or executable form under the terms of
Paragraphs 1 and 2 above provided that you also do one of the following:
a) accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of
Paragraphs 1 and 2 above; or,
b) accompany it with a written offer, valid for at least three
years, to give any third party free (except for a nominal charge
for the cost of distribution) a complete machine-readable copy of the
corresponding source code, to be distributed under the terms of
Paragraphs 1 and 2 above; or,
c) accompany it with the information you received as to where the
corresponding source code may be obtained. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form alone.)
Source code for a work means the preferred form of the work for making
modifications to it. For an executable file, complete source code means
all the source code for all modules it contains; but, as a special
exception, it need not include source code for modules which are standard
libraries that accompany the operating system on which the executable
file runs, or for standard header files or definitions files that
accompany that operating system.
4. You may not copy, modify, sublicense, distribute or transfer the
Program except as expressly provided under this General Public License.
Any attempt otherwise to copy, modify, sublicense, distribute or transfer
the Program is void, and will automatically terminate your rights to use
the Program under this License. However, parties who have received
copies, or rights to use copies, from you under this General Public
License will not have their licenses terminated so long as such parties
remain in full compliance.
5. By copying, distributing or modifying the Program (or any work based
on the Program) you indicate your acceptance of this license to do so,
and all its terms and conditions.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the original
licensor to copy, distribute or modify the Program subject to these
terms and conditions. You may not impose any further restrictions on the
recipients' exercise of the rights granted herein.
7. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of the license which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
the license, you may choose any version ever published by the Free Software
Foundation.
8. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
Appendix: How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to humanity, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
To do so, attach the following notices to the program. It is safest to
attach them to the start of each source file to most effectively convey
the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) 19yy <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 1, or (at your option)
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19xx name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the
appropriate parts of the General Public License. Of course, the
commands you use may be called something other than `show w' and `show
c'; they could even be mouse-clicks or menu items--whatever suits your
program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
program `Gnomovision' (a program to direct compilers to make passes
at assemblers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
That's all there is to it!
--- The Artistic License 1.0 ---
This software is Copyright (c) 2016 by Joseph Brenner, <doom@kzsu.stanford.edu>.
This is free software, licensed under:
The Artistic License 1.0
The Artistic License
Preamble
The intent of this document is to state the conditions under which a Package
may be copied, such that the Copyright Holder maintains some semblance of
artistic control over the development of the package, while giving the users of
the package the right to use and distribute the Package in a more-or-less
customary fashion, plus the right to make reasonable modifications.
Definitions:
- "Package" refers to the collection of files distributed by the Copyright
Holder, and derivatives of that collection of files created through
textual modification.
- "Standard Version" refers to such a Package if it has not been modified,
or has been modified in accordance with the wishes of the Copyright
Holder.
- "Copyright Holder" is whoever is named in the copyright or copyrights for
the package.
- "You" is you, if you're thinking about copying or distributing this Package.
- "Reasonable copying fee" is whatever you can justify on the basis of media
cost, duplication charges, time of people involved, and so on. (You will
not be required to justify it to the Copyright Holder, but only to the
computing community at large as a market that must bear the fee.)
- "Freely Available" means that no fee is charged for the item itself, though
there may be fees involved in handling the item. It also means that
recipients of the item may redistribute it under the same conditions they
received it.
1. You may make and give away verbatim copies of the source form of the
Standard Version of this Package without restriction, provided that you
duplicate all of the original copyright notices and associated disclaimers.
2. You may apply bug fixes, portability fixes and other modifications derived
from the Public Domain or from the Copyright Holder. A Package modified in such
a way shall still be considered the Standard Version.
3. You may otherwise modify your copy of this Package in any way, provided that
you insert a prominent notice in each changed file stating how and when you
changed that file, and provided that you do at least ONE of the following:
a) place your modifications in the Public Domain or otherwise make them
Freely Available, such as by posting said modifications to Usenet or an
equivalent medium, or placing the modifications on a major archive site
such as ftp.uu.net, or by allowing the Copyright Holder to include your
modifications in the Standard Version of the Package.
b) use the modified Package only within your corporation or organization.
c) rename any non-standard executables so the names do not conflict with
standard executables, which must also be provided, and provide a separate
manual page for each non-standard executable that clearly documents how it
differs from the Standard Version.
d) make other distribution arrangements with the Copyright Holder.
4. You may distribute the programs of this Package in object code or executable
form, provided that you do at least ONE of the following:
a) distribute a Standard Version of the executables and library files,
together with instructions (in the manual page or equivalent) on where to
get the Standard Version.
b) accompany the distribution with the machine-readable source of the Package
with your modifications.
c) accompany any non-standard executables with their corresponding Standard
Version executables, giving the non-standard executables non-standard
names, and clearly documenting the differences in manual pages (or
equivalent), together with instructions on where to get the Standard
Version.
d) make other distribution arrangements with the Copyright Holder.
5. You may charge a reasonable copying fee for any distribution of this
Package. You may charge any fee you choose for support of this Package. You
may not charge a fee for this Package itself. However, you may distribute this
Package in aggregate with other (possibly commercial) programs as part of a
larger (possibly commercial) software distribution provided that you do not
advertise this Package as a product of your own.
6. The scripts and library files supplied as input to or produced as output
from the programs of this Package do not automatically fall under the copyright
of this Package, but belong to whomever generated them, and may be sold
commercially, and may be aggregated with this Package.
7. C or perl subroutines supplied by you and linked into this Package shall not
be considered part of this Package.
8. The name of the Copyright Holder may not be used to endorse or promote
products derived from this software without specific prior written permission.
9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
The End
# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.008.
Build.PL
Changes
LICENSE
MANIFEST
META.json
META.yml
README
cpanfile
dist.ini
lib/Scalar/Classify.pm
t/01-Scalar-Classify-classify.t
t/02-Scalar-Classify-classify_pair.t
t/03-Scalar-Classify-classify_pair-mismatch.t
t/04-Scalar-Classify-classify_pair-also_qualify.t
t/author-pod-syntax.t
{
"abstract" : "get type and class information for scalars",
"author" : [
"Joseph Brenner, <doom@kzsu.stanford.edu>"
],
"dynamic_config" : 0,
"generated_by" : "Dist::Milla version v1.0.16, Dist::Zilla version 6.008, CPAN::Meta::Converter version 2.143240",
"license" : [
"perl_5"
],
"meta-spec" : {
"url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
"version" : "2"
},
"name" : "Scalar-Classify",
"no_index" : {
"directory" : [
"eg",
"examples",
"inc",
"share",
"t",
"xt"
]
},
"prereqs" : {
"configure" : {
"requires" : {
"Module::Build::Tiny" : "0.034"
}
},
"develop" : {
"requires" : {
"Dist::Milla" : "v1.0.16",
"Test::Pod" : "1.41"
}
},
"runtime" : {
"requires" : {
"Carp" : "0",
"Data::Dumper" : "0",
"Exporter" : "0",
"Scalar::Util" : "0",
"perl" : "5.008005"
}
},
"test" : {
"requires" : {
"FindBin" : "0",
"Test::Deep" : "0",
"Test::Exception" : "0",
"Test::More" : "0.96",
"lib" : "0"
}
}
},
"release_status" : "stable",
"resources" : {
"bugtracker" : {
"web" : "https://github.com/doomvox/scalar-classify/issues"
},
"homepage" : "https://github.com/doomvox/scalar-classify",
"repository" : {
"type" : "git",
"url" : "https://github.com/doomvox/scalar-classify.git",
"web" : "https://github.com/doomvox/scalar-classify"
}
},
"version" : "0.02",
"x_contributors" : [
"Joseph Brenner <doomvox@gmail.com>"
],
"x_serialization_backend" : "JSON::XS version 2.34"
}
---
abstract: 'get type and class information for scalars'
author:
- 'Joseph Brenner, <doom@kzsu.stanford.edu>'
build_requires:
FindBin: '0'
Test::Deep: '0'
Test::Exception: '0'
Test::More: '0.96'
lib: '0'
configure_requires:
Module::Build::Tiny: '0.034'
dynamic_config: 0
generated_by: 'Dist::Milla version v1.0.16, Dist::Zilla version 6.008, CPAN::Meta::Converter version 2.143240'
license: perl
meta-spec:
url: http://module-build.sourceforge.net/META-spec-v1.4.html
version: '1.4'
name: Scalar-Classify
no_index:
directory:
- eg
- examples
- inc
- share
- t
- xt
requires:
Carp: '0'
Data::Dumper: '0'
Exporter: '0'
Scalar::Util: '0'
perl: '5.008005'
resources:
bugtracker: https://github.com/doomvox/scalar-classify/issues
homepage: https://github.com/doomvox/scalar-classify
repository: https://github.com/doomvox/scalar-classify.git
version: '0.02'
x_contributors:
- 'Joseph Brenner <doomvox@gmail.com>'
x_serialization_backend: 'YAML::Tiny version 1.64'
NAME
Scalar::Classify - get type and class information for scalars
SYNOPSIS
use Scalar::Classify qw( classify classify_pair );
# determine the type (e.g. HASH for a hashref) and the object class (if any)
my ( $type, $class ) = classify( $some_scalar );
# warn if two args differ, supply default if one is undef
my $default_value =
classify_pair( $arg1, $arg2 );
# Also get type and class; error out if two args differ
my ( $default_value, $type, $class ) =
classify_pair( $arg1, $arg2, { mismatch_policy => 'error' });
# If a given ref was undef, replace it with a default value
classify_pair( $arg1, $arg2, { also_qualify => 1 });
DESCRIPTION
Scalar::Classify provides a routine named "classify" that can be used
to examine a given argument to determine it's type and class (if any).
Here "type" means either the return from reftype (, or if it's a
scalar, a code indicating whether it's a string or a number, and
"class" it the object class, the way a reference has been blessed.
This module also provides the routine "classify_pair", which looks at a
pair of variables intended to be of the same type, and if at least one
of them is defined, uses that to get an appropriate default value for
that type.
MOTIVATION
Perl contains a built-in "ref" function, and has some useful routines
in the standard Scalar::Util library ('ref', 'looks_like_number') which
can be used to examine the type of an argument. The classify routine
provided here internally uses all three of these, returning a
two-values that describe the kind of thing you're examining.
The immediate goal was to provide support routines for the Data::Math
project.
EXPORT
None by default. Optionally:
classify
Example usage:
my ( $type, $class ) = classify( $some_var );
Returns two pieces of information, the underlying "type", and the
"class" (if this is a reference blessed into a class).
The type is most often (but not limited to) one of the following:
ARRAY
HASH
:NUMBER:
:STRING:
Other possibilities are the other potential returns from ref:
CODE
GLOB
LVALUE
FORMAT
IO
VSTRING
Regexp
Internally, this uses the built-in function ref and the library
functions reftype and looks_like_number (from Scalar::Util). The type
is the return from "reftype" (e.g "ARRAY", "HASH") except that in the
case of a simple scalar the type is a code to indicate whether it
seems to be a number (":NUMBER:") or a string (":STRING:").
Note: if the argument is undefined, the returned type is undef.
classify_pair
Examines a pair of arguments that are intended to be processed in
parallel and are expected to be of the same type:
If they're both defined, it checks that their types match. If at
least one is defined, it generates a default of the same type by
using the classify method. If both are undef, this default is also
undef.
In scalar context, it returns just the default value.
In list context, it returns the default plus the type and the class
(if it's a blessed reference).
An options hashref is accepted as a third argument, with allowed
options:
o mismatch_policy
If argument types mismatch, the behavior is determined by
the mismatch_policy option, defaulting to 'warn'.
The other allowed values are 'error' or 'silent'.
o also_qualify
If the "also_qualify" option is set to a true value, then
the given arguments may be modified in place: if one is
undef, it will be assigned the determined default.
Examples:
my $default_value =
classify_pair( $arg1, $arg2, { mismatch_policy => 'error' });
my ( $default_value, $type, $class ) =
classify_pair( $arg1, $arg2, { mismatch_policy => 'error' });
classify_pair( $arg1, $arg2, { also_qualify => 1 });
Note the slightly unusual polymorphic behavior: in scalar context
returns *just* the default_value, in list context, returns up to
three values, the default, the type and the class.
SEE ALSO
Params::Classify
This covers the argument checking case, where you want to verify that
something of the correct type was passed. The perl5-porters are
interested in adding core support for this module: it's fast and likely
to get faster.
AUTHOR
Joseph Brenner, <doom@kzsu.stanford.edu>
COPYRIGHT AND LICENSE
Copyright (C) 2016 by Joseph Brenner
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See http://dev.perl.org/licenses/ for more information.
requires 'perl', '5.008005';
requires 'Carp';
requires 'Data::Dumper';
requires 'Scalar::Util';
requires 'Exporter';
on test => sub {
requires 'Test::More', '0.96';
requires 'FindBin';
requires 'lib';
requires 'Test::Deep';
requires 'Test::Exception';
};
[@Milla]
lib/Scalar/Classify.pm view on Meta::CPAN
package Scalar::Classify;
# doom@kzsu.stanford.edu
# 30 Jun 2015
=head1 NAME
Scalar::Classify - get type and class information for scalars
=head1 SYNOPSIS
use Scalar::Classify qw( classify classify_pair );
# determine the type (e.g. HASH for a hashref) and the object class (if any)
my ( $type, $class ) = classify( $some_scalar );
# warn if two args differ, supply default if one is undef
my $default_value =
classify_pair( $arg1, $arg2 );
# Also get type and class; error out if two args differ
my ( $default_value, $type, $class ) =
classify_pair( $arg1, $arg2, { mismatch_policy => 'error' });
# If a given ref was undef, replace it with a default value
classify_pair( $arg1, $arg2, { also_qualify => 1 });
=head1 DESCRIPTION
Scalar::Classify provides a routine named "classify" that can be used
to examine a given argument to determine it's type and class (if any).
Here "type" means either the return from reftype (, or if it's a scalar,
a code indicating whether it's a string or a number, and "class"
it the object class, the way a reference has been blessed.
This module also provides the routine "classify_pair", which
looks at a pair of variables intended to be of the same type, and
if at least one of them is defined, uses that to get an
appropriate default value for that type.
=head2 MOTIVATION
Perl contains a built-in "ref" function, and has some useful
routines in the standard Scalar::Util library ('ref',
'looks_like_number') which can be used to examine the type of an
argument. The classify routine provided here internally uses all
three of these, returning a two-values that describe the kind of
thing you're examining.
The immediate goal was to provide support routines for the
L<Data::Math> project.
=head2 EXPORT
None by default. Optionally:
=over
=cut
use 5.008;
use strict;
use warnings;
my $DEBUG = 1;
use Carp;
use Data::Dumper;
use Scalar::Util qw( reftype looks_like_number );
our (@ISA, @EXPORT_OK, %EXPORT_TAGS, @EXPORT);
BEGIN {
require Exporter;
@ISA = qw(Exporter);
%EXPORT_TAGS = ( 'all' => [
qw(
classify
classify_pair
) ] );
# The above allows use Scalar::Classify ':all';
@EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
@EXPORT = qw( );
}
our $VERSION = '0.02';
=item classify
Example usage:
my ( $type, $class ) = classify( $some_var );
Returns two pieces of information, the underlying "type", and the
"class" (if this is a reference blessed into a class).
The type is most often (but not limited to) one of the following:
ARRAY
HASH
:NUMBER:
:STRING:
Other possibilities are the other potential returns from L<ref>:
CODE
GLOB
LVALUE
FORMAT
IO
VSTRING
Regexp
Internally, this uses the built-in function L<ref> and the library
functions L<reftype> and L<looks_like_number> (from L<Scalar::Util>).
The type is the return from "reftype" (e.g "ARRAY", "HASH")
except that in the case of a simple scalar the type is a code to
indicate whether it seems to be a number (":NUMBER:") or a string
(":STRING:").
Note: if the argument is undefined, the returned type is undef.
=cut
sub classify {
my $arg = shift;
# initialize $type to ref()
my $type = ref( $arg ); # '' if undef
my $basetype = reftype( $arg ) ; # undef if undef
my $class; # default undef
# it's a blessed ref when ref() not same as reftype()
if ( defined( $basetype ) && $type ne $basetype ) {
$class = $type;
$type = $basetype;
}
if( defined $arg ) {
# if not reference, we're handling a scalar
if ( not( defined( $basetype ) ) ) {
if( looks_like_number( $arg ) ) {
$type = ':NUMBER:';
} else {
$type = ':STRING:';
}
}
} else {
$type = undef; # more perlish than an empty string
}
my @meta = ( $type, $class );
return wantarray ? @meta : \@meta;
}
=item classify_pair
Examines a pair of arguments that are intended to be processed in
parallel and are expected to be of the same type:
If they're both defined, it checks that their types match.
If at least one is defined, it generates a default of the
same type by using the L<classify> method. If both are
undef, this default is also undef.
In scalar context, it returns just the default value.
In list context, it returns the default plus the type and
the class (if it's a blessed reference).
An options hashref is accepted as a third argument, with
allowed options:
o mismatch_policy
If argument types mismatch, the behavior is determined by
the mismatch_policy option, defaulting to 'warn'.
The other allowed values are 'error' or 'silent'.
o also_qualify
If the "also_qualify" option is set to a true value, then
the given arguments may be modified in place: if one is
undef, it will be assigned the determined default.
Examples:
my $default_value =
classify_pair( $arg1, $arg2, { mismatch_policy => 'error' });
my ( $default_value, $type, $class ) =
classify_pair( $arg1, $arg2, { mismatch_policy => 'error' });
classify_pair( $arg1, $arg2, { also_qualify => 1 });
Note the slightly unusual polymorphic behavior: in scalar
context returns *just* the default_value, in list context,
returns up to three values, the default, the type and the class.
=cut
sub classify_pair {
my $subname = ( caller(0) )[3];
my $opt = $_[2];
my $policy = $opt->{ mismatch_policy } || 'warn';
my $do_qualify = $opt->{ also_qualify } || 0;
my $meta1 = classify( $_[0] );
my $meta2 = classify( $_[1] );
# handle mismatched types
if ( $policy ne 'silent' ) {
no warnings 'uninitialized';
if ( defined( $_[0] ) && defined( $_[1] ) ) {
unless( $meta1->[0] eq $meta2->[0] ) {
croak "mismatched types: $meta1->[0] and $meta2->[0]" if $policy eq 'error';
carp "mismatched types: $meta1->[0] and $meta2->[0]" if $policy eq 'warn';
}
unless( $meta1->[1] eq $meta2->[1] ) {
croak "mismatched classes: $meta1->[1] and $meta2->[1]" if $policy eq 'error';
carp "mismatched classes: $meta1->[1] and $meta2->[1]" if $policy eq 'warn';
}
}
}
my ( $defval, $class, $type );
{ no warnings 'uninitialized';
$type = $meta1->[0] || $meta2->[0];
}
unless( defined( $type ) ) {
return wantarray ? ( undef, undef, undef ) : undef;
}
if ( $type eq ':NUMBER:' ) {
$defval = 0;
} elsif ( $type eq ':STRING:' ) {
$defval = '';
} else {
{ no warnings 'uninitialized';
$class = $meta1->[1] || $meta2->[1];
}
if ( $type eq 'ARRAY' ) {
$defval = [];
} elsif ( $type eq 'HASH' ) {
$defval = {};
} elsif ( $type eq 'SCALAR' ) {
my $var;
$defval = \$var;
} else { # handle the useless cases: warn and get out of here
carp "$subname can't do anything useful with ref type $type";
}
}
if( defined( $defval ) && defined( $class ) ) {
bless( $defval, $class );
}
if( $do_qualify ) {
$_[0] = $defval unless defined( $_[0] );
$_[1] = $defval unless defined( $_[1] );
}
return wantarray ? ( $defval, $type, $class ) : $defval;
}
1;
=back
=head1 SEE ALSO
L<Params::Classify>
This covers the argument checking case, where you want to verify
that something of the correct type was passed. The perl5-porters
are interested in adding core support for this module: it's fast
and likely to get faster.
=head1 AUTHOR
Joseph Brenner, E<lt>doom@kzsu.stanford.eduE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2016 by Joseph Brenner
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
See http://dev.perl.org/licenses/ for more information.
=cut
t/01-Scalar-Classify-classify.t view on Meta::CPAN
# Perl test file, can be run like so:
# perl 01-Scalar-Classify-classify.t
# jbrenner@ffn.com 2014/09/15
use warnings;
use strict;
$|=1;
my $DEBUG = 0; # TODO set to 0 before ship
use Data::Dumper;
# use File::Path qw( mkpath );
# use File::Basename qw( fileparse basename dirname );
# use File::Copy qw( copy move );
# use Fatal qw( open close mkpath copy move );
# use Cwd qw( cwd abs_path );
# use Env qw( HOME );
# use List::MoreUtils qw( any );
use Test::More;
use FindBin qw( $Bin );
use lib "$Bin/../lib";
use_ok( 'Scalar::Classify', qw( classify ) );
($DEBUG) && print STDERR $ENV{ PERL5LIB }, "\n";
($DEBUG) && print STDERR Dumper( \@INC ), "\n";
{
my $test_name = "Testing classify";
my $scaley_one = 666;
my $scaley = $scaley_one;
my $classy = 'Beast';
my $stringy = 'Dali';
my $code_ref = sub{ my $self = shift; $self->whatever; };
my $hobj = bless( {}, $classy ) ;
my $aobj = bless( [], $classy ) ;
my $sobj = bless( \$scaley, $classy ) ;
my $alt_code_ref = sub{ my $self = shift; $self->nevermore; };
my $cobj = bless( $alt_code_ref, $classy );
# CODE
my @cases =
(
[ 'basic hashref', {}, [ 'HASH', undef ] ],
[ 'basic arrayref', [], [ 'ARRAY', undef ] ],
[ 'basic scalar ref', \$scaley_one, [ 'SCALAR', undef ] ],
[ 'blessed hashref', $hobj, [ 'HASH', $classy ] ],
[ 'blessed arrayref', $aobj, [ 'ARRAY', $classy ] ],
[ 'blessed scalarref', $sobj, [ 'SCALAR', $classy ] ],
[ 'numeric scalar', $scaley, [ ':NUMBER:', undef ] ],
[ 'string scalar', $stringy, [ ':STRING:', undef ] ],
[ 'basic code ref', $code_ref, [ 'CODE', undef ] ],
[ 'blessed code ref', $cobj, [ 'CODE', $classy ] ],
);
foreach my $case ( @cases ) {
my( $case, $arg, $exp ) = @{ $case };
my $meta = classify( $arg );
# print "got: ", Dumper( $meta ), "\n";
# print "exp: ", Dumper( $exp ), "\n";
is_deeply( $meta, $exp, "$test_name on $case" );
}
}
{
my $test_name = "Testing classify on useless cases";
# ref
# LVALUE You get this from taking the reference of function calls like "pos()" or "substr()".
# GLOB
# REF wtf?
# FORMAT
# IO
# VSTRING
# Regexp
my $stringy = "Foal shoals, and fouler bottoms beneath, our daddies, floundered nameless pygmy trees.";
my $substr_ref = \substr( $stringy, 32, 7 );
# ${ $substr_ref } = 'ABOVE'; # replace 'beneath' with "ABOVE'
# print $stringy, "\n";
my $fl_substr_ref = \substr( $stringy, 32+23, 10 );
# (using "our" here to get table slots I can glob without warning)
our $classy = 'Society';
bless( $fl_substr_ref, $classy );
our @cases =
(
[ 'lvalue (a substr ref)', $substr_ref, [ 'LVALUE', undef ] ],
[ 'lvalue (a substr ref)', $fl_substr_ref, [ 'LVALUE', 'Society' ] ],
);
my $one_glob_ref = \*cases;
my $glob_ref = \*classy;
bless( $one_glob_ref, $classy );
my @more_cases =
(
[ 'symbol table glob', $glob_ref, [ 'GLOB', undef ] ],
[ 'symbol table glob', $one_glob_ref, [ 'GLOB', $classy ] ],
);
push @cases, @more_cases;
# I don't understand how these work, and it's useless beyond useless,
# no one uses perlform formats.
#
# my $formatref = *more_cases{FORMAT};
# my $formatref_obj = *more_cases{FORMAT};
# bless( $formatref_obj, $classy );
# my @and_yes_more_cases =
# (
# [ 'formatref', $formatref, [ 'FORMAT', undef ] ],
# [ 'blessed formatref', $formatref_obj, [ 'FORMAT', $classy ] ],
# );
# push @cases, @and_yes_more_cases;
foreach my $case ( @cases ) {
my( $case, $arg, $exp ) = @{ $case };
my $meta = classify( $arg );
if( $DEBUG ) {
print "case: ", $case, "\n";
print "got: ", Dumper( $meta ), "\n";
print "exp: ", Dumper( $exp ), "\n";
}
is_deeply( $meta, $exp, "$test_name like a $case" );
}
}
{ my $test_name = "Testing classify on more useless cases";
# an easy way to get IO refs
my $ioref = *STDIN{IO};
my $ioref_obj = *STDERR{IO};
# # (using "our" here to get table slots I can glob without warning)
# our $classy = 'Society';
my $classy = 'Style';
bless( $ioref_obj, $classy );
my( $case, $arg, $exp ) =
# even unblessed IO has class
( 'ioref', $ioref, [ 'IO', 'IO::Handle' ] );
my $meta = classify( $arg );
my $first = $meta->[0];
my $second = $meta->[1];
is( $first, $exp->[0], # 'IO'
"$test_name like a $case: 1st element" );
my $exp_re = qr{ ^ IO:: (?: File | Handle ) $ }x;
like( $second, $exp_re,
"$test_name like a $case: 2nd element" );
( $case, $arg, $exp ) =
# even unblessed IO has class
( 'blessed ioref', $ioref_obj, [ 'IO', $classy ] );
$meta = classify( $arg );
is_deeply( $meta, $exp, "$test_name like a $case" );
}
done_testing();
t/02-Scalar-Classify-classify_pair.t view on Meta::CPAN
# 02-Scalar-Classify-classify_pair.t
# jbrenner@ffn.com 2014/09/15
use warnings;
use strict;
$|=1;
my $DEBUG = 1; # TODO set to 0 before ship
use Data::Dumper;
# use File::Path qw( mkpath );
# use File::Basename qw( fileparse basename dirname );
# use File::Copy qw( copy move );
# use Fatal qw( open close mkpath copy move );
# use Cwd qw( cwd abs_path );
# use Env qw( HOME );
# use List::MoreUtils qw( any );
use Test::More;
use Test::Deep qw( cmp_deeply ); #
use FindBin qw( $Bin );
use lib "$Bin/../lib";
use_ok( 'Scalar::Classify', qw( classify classify_pair ) );
{
my $test_name = "Testing classify_pair";
my $case = "blessed href";
my $classy = 'Beast';
my $hobj = bless( {}, $classy ) ;
my( $arg1, $arg2 ) = ( $hobj, undef );
my $default =
classify_pair( $arg1, $arg2 );
my $exp = bless( {}, 'Beast' );
cmp_deeply( $default, $exp, "$test_name: $case" );
}
{
my $test_name = "Testing classify_pair";
my $case = "Blessed arrayref";
my $classy = 'Beast';
my $aobj = bless( [], $classy ) ;
$aobj = bless( [], $classy ) ;
my ($arg1, $arg2) = ( undef, $aobj );
my ( $default, $type, $class ) =
classify_pair( $arg1, $arg2 );
my ($exp_def, $exp_type, $exp_class) =
( bless( [], $classy ),
'ARRAY',
$classy
);
cmp_deeply( $default, $exp_def, "$test_name: $case (was undef): default" );
is( $type, $exp_type, "$test_name: $case (was undef): type" );
is( $class, $exp_class, "$test_name: $case (was undef): class" );
}
{
my $test_name = "Testing classify_pair";
my $case = "Numeric scalar";
my $scaley_one = 666;
my $scaley = $scaley_one;
my ($arg1, $arg2) = ( $scaley, undef );
my ( $default, $type, $class ) =
classify_pair( $arg1, $arg2 );
my ($exp_def, $exp_type, $exp_class) =
( 0 ,
':NUMBER:',
undef
);
cmp_deeply( $default, $exp_def, "$test_name: $case (was undef): default" );
is( $type, $exp_type, "$test_name: $case (was undef): type" );
cmp_deeply( $class, $exp_class, "$test_name: $case (was undef): class" );
}
{
my $test_name = "Testing classify_pair";
my $case = "String scalar";
my $stringy = 'Dali';
my ($arg1, $arg2) = ( undef, $stringy );
my ( $default, $type, $class ) =
classify_pair( $arg1, $arg2 );
my ($exp_def, $exp_type, $exp_class) =
( '' ,
':STRING:',
undef
);
cmp_deeply( $default, $exp_def, "$test_name: $case (was undef): default" );
is( $type, $exp_type, "$test_name: $case (was undef): type" );
cmp_deeply( $class, $exp_class, "$test_name: $case (was undef): class" );
}
{
my $test_name = "Testing classify_pair";
my $case = "Simple href";
my ($arg1, $arg2) = ( undef, {} );
my ( $default, $type, $class ) =
classify_pair( $arg1, $arg2 );
my ($exp_def, $exp_type, $exp_class) =
( {} ,
'HASH',
undef
);
cmp_deeply( $default, $exp_def, "$test_name: $case (was undef): default" );
is( $type, $exp_type, "$test_name: $case (was undef): type" );
cmp_deeply( $class, $exp_class, "$test_name: $case (was undef): class" );
}
{
my $test_name = "Testing classify_pair";
my $case = "Simple aref";
my ($arg1, $arg2) = ( undef, [] );
my ( $default, $type, $class ) =
classify_pair( $arg1, $arg2 );
my ($exp_def, $exp_type, $exp_class) =
( [],
'ARRAY',
undef
);
cmp_deeply( $default, $exp_def, "$test_name: $case (was undef): default" );
is( $type, $exp_type, "$test_name: $case (was undef): type" );
cmp_deeply( $class, $exp_class, "$test_name: $case (was undef): class" );
}
done_testing();
t/03-Scalar-Classify-classify_pair-mismatch.t view on Meta::CPAN
# 03-Scalar-Classify-classify_pair-mismatch.t
# jbrenner@ffn.com 2014/09/15
use warnings;
use strict;
$|=1;
my $DEBUG = 1; # TODO set to 0 before ship
use Data::Dumper;
# use File::Path qw( mkpath );
# use File::Basename qw( fileparse basename dirname );
# use File::Copy qw( copy move );
# use Fatal qw( open close mkpath copy move );
# use Cwd qw( cwd abs_path );
# use Env qw( HOME );
# use List::MoreUtils qw( any );
use Test::More;
use Test::Deep qw( cmp_deeply ); #
use Test::Exception;
use FindBin qw($Bin);
use FindBin qw( $Bin );
use lib "$Bin/../lib";
use_ok( 'Scalar::Classify', qw( classify classify_pair ) );
{
my $test_name = "Testing classify_pair";
my $case = "mismatched blessed href and blessed aref";
my $hobj1 = bless( {}, 'Beast' ) ;
my $aobj2 = bless( [], 'Beast' ) ;
throws_ok {
classify_pair( $hobj1, $aobj2, { mismatch_policy => 'error' } );
} qr{mismatched types}, "$test_name: $case";
}
{
my $test_name = "Testing classify_pair";
my $case = "mismatched classes of blessed href";
my $hobj1 = bless( {}, 'Beast' ) ;
my $hobj2 = bless( {}, 'Beauty' ) ;
throws_ok {
classify_pair( $hobj1, $hobj2, { mismatch_policy => 'error' } );
} qr{mismatched classes}, "$test_name: $case";
}
{
my $test_name = "Testing classify_pair";
my $case = "Numeric scalar";
my $subcase = "(second was undef)";
my $scaley_one = 666;
my $scaley = $scaley_one;
my ($arg1, $arg2) = ( $scaley, undef );
my ( $default, $type, $class ) =
classify_pair( $arg1, $arg2 );
my ($exp_def, $exp_type, $exp_class) =
( 0 ,
':NUMBER:',
undef
);
cmp_deeply( $default, $exp_def, "$test_name: $case $subcase: default" );
is( $type, $exp_type, "$test_name: $case $subcase: type" );
cmp_deeply( $class, $exp_class, "$test_name: $case $subcase: class" );
}
{
my $test_name = "Testing classify_pair";
my $case = "Numeric scalar";
my $subcase = "(first was undef)";
my $scaley_one = 666;
my $scaley = $scaley_one;
my ($arg1, $arg2) = ( undef, $scaley );
my ( $default, $type, $class ) =
classify_pair( $arg1, $arg2 );
my ($exp_def, $exp_type, $exp_class) =
( 0 ,
':NUMBER:',
undef
);
cmp_deeply( $default, $exp_def, "$test_name: $case $subcase: default" );
is( $type, $exp_type, "$test_name: $case $subcase: type" );
cmp_deeply( $class, $exp_class, "$test_name: $case $subcase: class" );
}
{
my $test_name = "Testing classify_pair";
my $case = "Mismatched numeric and string"; ### TODO this is a hard one
my $subcase = "(first was string)";
my $scaley_one = 666;
my $scaley = $scaley_one;
my $tail = "fins";
my ($arg1, $arg2) = ( $tail, $scaley );
throws_ok {
classify_pair( $arg1, $arg2, { mismatch_policy => 'error' } );
} qr{mismatched types}, "$test_name: $case $subcase";
}
{
my $test_name = "Testing classify_pair";
my $case = "Mismatched numeric and string"; ### TODO this is a hard one
my $subcase = "(second was string)";
my $scaley_one = 666;
my $scaley = $scaley_one;
my $tail = "fins";
my ($arg1, $arg2) = ( $scaley, $tail );
throws_ok {
classify_pair( $arg1, $arg2, { mismatch_policy => 'error' } );
} qr{mismatched types}, "$test_name: $case $subcase";
}
### TODO what other cases are worth testing?
### o mechanically make a list of "classify" types, generate cross-comparisons.
### o test default 'warn' behavior?
### o try other numerics besides an integer.
### TODO
### the habit here of keeping a copy of the integer in another variable
### is interesting... was the idea to test whether the numeric value
### changed, or became stringified, or something?
### END
done_testing();
exit;
t/04-Scalar-Classify-classify_pair-also_qualify.t view on Meta::CPAN
# Run this like so: `perl 04-Scalar-Classify-classify_pair-also_qualify.t'
# doom@kzsu.stanford.edu 2015/12/03 02:53:27
use warnings;
use strict;
$|=1;
my $DEBUG = 1; # TODO set to 0 before ship
use Data::Dumper;
# use File::Path qw( mkpath );
# use File::Basename qw( fileparse basename dirname );
# use File::Copy qw( copy move );
# use Fatal qw( open close mkpath copy move );
# use Cwd qw( cwd abs_path );
# use Env qw( HOME );
# use List::MoreUtils qw( any );
use Test::More;
use Test::Deep qw( cmp_deeply ); #
use FindBin qw( $Bin );
use lib "$Bin/../lib";
use_ok( 'Scalar::Classify', qw( classify classify_pair ) );
{
my $test_name = "Testing classify_pair without also_qualify";
my $case = "Simple href";
my ($arg1, $arg2) = ( undef, {} );
my ( $default, $type, $class ) =
classify_pair( $arg1, $arg2 );
my ($exp_def, $exp_type, $exp_class) =
( {} ,
'HASH',
undef
);
cmp_deeply( $default, $exp_def, "$test_name: $case (was undef): default" );
is( $type, $exp_type, "$test_name: $case (was undef): type" );
cmp_deeply( $class, $exp_class, "$test_name: $case (was undef): class" );
my ($arg1_basetype, $arg1_class) = classify( $arg1 );
my ($arg2_basetype, $arg2_class) = classify( $arg2 );
is( $arg1_basetype, undef, "$test_name: first arg IS STILL undef" );
is( $arg2_basetype, 'HASH', "$test_name: second arg still href" );
}
{
my $test_name = "Testing classify_pair with also_qualify";
my $case = "Simple href";
my ($arg1, $arg2) = ( undef, {} );
my ( $default, $type, $class ) =
classify_pair( $arg1, $arg2, { also_qualify => 1 });
my ($exp_def, $exp_type, $exp_class) =
( {} ,
'HASH',
undef
);
cmp_deeply( $default, $exp_def, "$test_name: $case (was undef): default" );
is( $type, $exp_type, "$test_name: $case (was undef): type" );
cmp_deeply( $class, $exp_class, "$test_name: $case (was undef): class" );
my ($arg1_basetype, $arg1_class) = classify( $arg1 );
my ($arg2_basetype, $arg2_class) = classify( $arg2 );
is( $arg1_basetype, 'HASH', "$test_name: first arg HAS BECOME href" );
is( $arg2_basetype, 'HASH', "$test_name: second arg still href" );
}
done_testing();
t/author-pod-syntax.t view on Meta::CPAN
#!perl
BEGIN {
unless ($ENV{AUTHOR_TESTING}) {
print qq{1..0 # SKIP these tests are for testing by the author\n};
exit
}
}
# This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests.
use strict; use warnings;
use Test::More;
use Test::Pod 1.41;
all_pod_files_ok();
( run in 0.901 second using v1.01-cache-2.11-cpan-39bf76dae61 )