File Coverage

blib/lib/MooseX/Types/Common.pm
Criterion Covered Total %
statement 12 12 100.0
branch 2 2 100.0
condition n/a
subroutine 4 4 100.0
pod n/a
total 18 18 100.0


line stmt bran cond sub pod time code
1             package MooseX::Types::Common; # git description: v0.001013-15-gb03d3d2
2             # ABSTRACT: A library of commonly used type constraints
3             # KEYWORDS: moose types classes objects constraints declare libraries strings numbers
4              
5             our $VERSION = '0.001014';
6              
7 1     1   467 use strict;
  1         1  
  1         24  
8 1     1   3 use warnings;
  1         0  
  1         40  
9 1     1   3 use Carp ();
  1         1  
  1         61  
10              
11             sub import {
12 2     2   7077 my $self = shift;
13 2 100       7 return unless @_;
14 1         218 Carp::cluck("Tried to import the symbols " . join(', ', @_)
15             . " from MooseX::Types::Common.\nDid you mean "
16             . "MooseX::Types::Common::String or MooseX::Type::Common::Numeric?");
17             }
18              
19             1;
20              
21             __END__
22              
23             =pod
24              
25             =encoding UTF-8
26              
27             =head1 NAME
28              
29             MooseX::Types::Common - A library of commonly used type constraints
30              
31             =head1 VERSION
32              
33             version 0.001014
34              
35             =head1 SYNOPSIS
36              
37             use MooseX::Types::Common::String qw/SimpleStr/;
38             has short_str => (is => 'rw', isa => SimpleStr);
39              
40             ...
41             #this will fail
42             $object->short_str("string\nwith\nbreaks");
43              
44              
45             use MooseX::Types::Common::Numeric qw/PositiveInt/;
46             has count => (is => 'rw', isa => PositiveInt);
47              
48             ...
49             #this will fail
50             $object->count(-33);
51              
52             =head1 DESCRIPTION
53              
54             A set of commonly-used type constraints that do not ship with Moose by default.
55              
56             =head1 SEE ALSO
57              
58             =over
59              
60             =item * L<MooseX::Types::Common::String>
61              
62             =item * L<MooseX::Types::Common::Numeric>
63              
64             =item * L<MooseX::Types>
65              
66             =item * L<Moose::Util::TypeConstraints>
67              
68             =back
69              
70             =head1 ORIGIN
71              
72             This distribution was extracted from the L<Reaction> code base by Guillermo
73             Roditi (groditi).
74              
75             =head1 SUPPORT
76              
77             Bugs may be submitted through L<the RT bug tracker|https://rt.cpan.org/Public/Dist/Display.html?Name=MooseX-Types-Common>
78             (or L<bug-MooseX-Types-Common@rt.cpan.org|mailto:bug-MooseX-Types-Common@rt.cpan.org>).
79              
80             There is also a mailing list available for users of this distribution, at
81             L<http://lists.perl.org/list/moose.html>.
82              
83             There is also an irc channel available for users of this distribution, at
84             L<C<#moose> on C<irc.perl.org>|irc://irc.perl.org/#moose>.
85              
86             =head1 AUTHORS
87              
88             =over 4
89              
90             =item *
91              
92             Matt S Trout - mst (at) shadowcatsystems.co.uk (L<http://www.shadowcatsystems.co.uk/>)
93              
94             =item *
95              
96             K. James Cheetham <jamie@shadowcatsystems.co.uk>
97              
98             =item *
99              
100             Guillermo Roditi <groditi@gmail.com>
101              
102             =back
103              
104             =head1 CONTRIBUTORS
105              
106             =for stopwords Karen Etheridge Justin Hunter Dave Rolsky Tomas Doran Toby Inkster Gregory Oschwald Denis Ibaev Graham Knop Caleb Cushing
107              
108             =over 4
109              
110             =item *
111              
112             Karen Etheridge <ether@cpan.org>
113              
114             =item *
115              
116             Justin Hunter <justin.d.hunter@gmail.com>
117              
118             =item *
119              
120             Dave Rolsky <autarch@urth.org>
121              
122             =item *
123              
124             Tomas Doran <bobtfish@bobtfish.net>
125              
126             =item *
127              
128             Toby Inkster <tobyink@cpan.org>
129              
130             =item *
131              
132             Gregory Oschwald <oschwald@gmail.com>
133              
134             =item *
135              
136             Denis Ibaev <dionys@gmail.com>
137              
138             =item *
139              
140             Graham Knop <haarg@haarg.org>
141              
142             =item *
143              
144             Gregory Oschwald <goschwald@maxmind.com>
145              
146             =item *
147              
148             Caleb Cushing <xenoterracide@gmail.com>
149              
150             =back
151              
152             =head1 COPYRIGHT AND LICENSE
153              
154             This software is copyright (c) 2009 by Matt S Trout - mst (at) shadowcatsystems.co.uk (L<http://www.shadowcatsystems.co.uk/>).
155              
156             This is free software; you can redistribute it and/or modify it under
157             the same terms as the Perl 5 programming language system itself.
158              
159             =cut