File Coverage

blib/lib/Readonly/Enum.pm

Criterion	Covered	Total	%
statement	27	27	100.0
branch	8	8	100.0
condition	2	3	66.6
subroutine	7	7	100.0
pod	0	1	0.0
total	44	46	95.6

package Readonly::Enum;

use v5.10;

use strict;
use warnings;

use version 0.77; our $VERSION = version->declare('v0.1.5');

use Carp;
use Scalar::Readonly qw/ readonly_on /;

=head1 NAME

Readonly::Enum - enumerated scalar values

=head1 SYNOPSIS

  use Readonly::Enum;

  # $foo = 1, $bar = 2, etc.

  Readonly::Enum my ($foo, $bar, $baz);

  # $foo = 0, $bar = 1, etc.

  Readonly::Enum my ($foo, $bar, $baz) => 0;

  # $foo = 0, $bar = 5, $baz = 6, etc.

  Readonly::Enum my ($foo, $bar, $baz) => (0, 5);

=head1 DESCRIPTION

This module provides some syntactic sugar for defining enumerated
scalar values.

It is to L what the L package is to L.
Unlike enumerated constants, these scalars can be used as hash keys
and interpolated in strings.

Unlike L, only integers are supported in this version.

=head1 AUTHOR

Robert Rothenberg C.

Current Maintainer, Nigel Horne, C<<  >>

=head1 LICENSE AND COPYRIGHT

Copyright 2013-2014 Robert Rothenberg.

This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:

L

Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=cut

sub Readonly::Enum
{
	my @vals  = grep { defined $_ } @_;

	my $i;

	my $start = 0;

	for($i = 0; $i < @_; $i++) {
		last if defined $_[$i];

		$start = @vals ? (shift @vals) : ++$start;

		Carp::croak('Initial values must be defined integers') unless(defined $start && $start =~ /^-?\d+\z/);

		readonly_on($_[$i] = $start);
	}

	Carp::croak('Too many initial values') if(scalar(@vals));

}

1;