NAME
Class::Tiny::ConstrainedAccessor - Generate Class::Tiny accessors that
apply type constraints
Class::Tiny uses custom accessors if they are defined before the "use
Class::Tiny" statement in a package. This module creates custom accessors
that behave as standard "Class::Tiny" accessors except that they apply
type constraints ("isa" relationships). Type constraints can come from
Type::Tiny, MooseX::Types, MooX::Types::MooseLike, MouseX::Types, or
Specio.
Example of a class using this package:
package SampleClass;
use Scalar::Util qw(looks_like_number);
use Type::Tiny;
my $MediumInteger;
BEGIN {
# Create the type constraint
$MediumInteger = Type::Tiny->new(
name => 'MediumInteger',
constraint => sub { looks_like_number($_) and $_ >= 10 and $_ < 20 }
);
}
use Class::Tiny::ConstrainedAccessor {
medint => $MediumInteger, # create accessor sub medint()
med_with_default => $MediumInteger,
};
# After using ConstrainedAccessor, actually define the class attributes.
use Class::Tiny qw(medint regular), {
med_with_default => 12,
};
SUBROUTINES
import
Creates the accessors you have requested. Usage:
use Class::Tiny::ConstrainedAccessor
[optional arrayref of option=>value],
name => constraint
[, name => constraint]... ;
The options use an arrayref to make them stand out against the
"name=>constraint" pairs that come after.
This also creates a "BUILD" in Class::Tiny to check the constructor
parameters if one doesn't exist. If one does exist, it creates the same
function as "_check_all_constraints" so that you can call it from your own
BUILD. It takes the same parameters as "BUILD".
OPTIONS
Remember, options are carried in an arrayref. This is to leave room for
someday carrying attributes and constraints in a hashref.
NOBUILD
If "NOBUILD => 1" is given, the constructor-parameter-checker is
created as "_check_all_constraints" regardless of whether "BUILD()"
exists or not. Example:
package MyClass;
use Class::Tiny::ConstrainedAccessor
[NOBUILD => 1],
foo => SomeConstraint;
AUTHOR
Christopher White, "<cxwembedded at gmail.com>". Thanks to Toby Inkster
for code contributions.
BUGS
Please report any bugs or feature requests through the GitHub Issues
interface at <
https://github.com/cxw42/Class-Tiny-ConstrainedAccessor>. I
will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Class::Tiny::ConstrainedAccessor
You can also look for information at:
* GitHub (report bugs here)
<
https://github.com/cxw42/Class-Tiny-ConstrainedAccessor>
* RT: CPAN's request tracker
<
https://rt.cpan.org/NoAuth/Bugs.html?Dist=Class-Tiny-ConstrainedAcces
sor>
* Search CPAN
<
https://metacpan.org/release/Class-Tiny-ConstrainedAccessor>
LICENSE
Copyright 2019 Christopher White.
This program is free software; you can redistribute it and/or modify it
under the terms of the the Apache License (2.0). You may obtain a copy of
the full license at:
<
https://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.