use warnings FATAL => 'all';
use strict;
-our $VERSION = '0.01';
+our $VERSION = '0.05';
+our $AUTHORITY = 'cpan:THEPLER';
-use MooseX::Getopt;
use Path::Class ();
+# TODO: export dir() and file() from Path::Class? (maybe)
use MooseX::Types
-declare => [qw( Dir File )];
-use MooseX::Types::Moose qw(Object Str ArrayRef);
+use MooseX::Types::Moose qw(Str ArrayRef);
-subtype Dir,
- as Object, where { $_->isa('Path::Class::Dir') };
+class_type('Path::Class::Dir');
+class_type('Path::Class::File');
-coerce Dir,
- from Str, via { Path::Class::Dir->new($_) },
- from ArrayRef, via { Path::Class::Dir->new(@$_) };
+subtype Dir, as 'Path::Class::Dir';
+subtype File, as 'Path::Class::File';
-MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
- Dir, '=s',
-);
+for my $type ( 'Path::Class::Dir', Dir ) {
+ coerce $type,
+ from Str, via { Path::Class::Dir->new($_) },
+ from ArrayRef, via { Path::Class::Dir->new(@$_) };
+}
+for my $type ( 'Path::Class::File', File ) {
+ coerce $type,
+ from Str, via { Path::Class::File->new($_) },
+ from ArrayRef, via { Path::Class::File->new(@$_) };
+}
-subtype 'Path::Class::Dir',
- as Object, where { $_->isa('Path::Class::Dir') };
-
-coerce 'Path::Class::Dir',
- from Str, via { Path::Class::Dir->new($_) },
- from ArrayRef, via { Path::Class::Dir->new(@$_) };
-
-MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
- 'Path::Class::Dir', '=s',
-);
-
-
-subtype File,
- as Object, where { $_->isa('Path::Class::File') };
-
-coerce File,
- from Str, via { Path::Class::File->new($_) },
- from ArrayRef, via { Path::Class::File->new(@$_) };
-
-MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
- File, '=s',
-);
-
-
-subtype 'Path::Class::File',
- as Object, where { $_->isa('Path::Class::File') };
-
-coerce 'Path::Class::File',
- from Str, via { Path::Class::File->new($_) },
- from ArrayRef, via { Path::Class::File->new(@$_) };
-
-MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
- 'Path::Class::File', '=s',
-);
-
+# optionally add Getopt option type
+eval { require MooseX::Getopt; };
+if ( !$@ ) {
+ MooseX::Getopt::OptionTypeMap->add_option_type_to_map( $_, '=s', )
+ for ( 'Path::Class::Dir', 'Path::Class::File', Dir, File, );
+}
1;
__END__
+
=head1 NAME
MooseX::Types::Path::Class - A Path::Class type library for Moose
package MyClass;
use Moose;
- use MooseX::Types::Path::Class qw( Dir File );
- with 'MooseX::Getopt'; # if you want the Getopt Role
+ use MooseX::Types::Path::Class;
+ with 'MooseX::Getopt'; # optional
has 'dir' => (
is => 'ro',
- isa => Dir,
+ isa => 'Path::Class::Dir',
required => 1,
coerce => 1,
);
has 'file' => (
is => 'ro',
- isa => File,
+ isa => 'Path::Class::File',
required => 1,
coerce => 1,
);
# these attributes are coerced to the
# appropriate Path::Class objects
- Foo->new( dir => '/some/directory/', file => '/some/file' );
+ MyClass->new( dir => '/some/directory/', file => '/some/file' );
=head1 DESCRIPTION
-This is a utility that creates common L<Moose> subtypes, coercions and
-option specifications useful for dealing with L<Path::Class> objects
-as L<Moose> attributes.
+MooseX::Types::Path::Class creates common L<Moose> types,
+coercions and option specifications useful for dealing
+with L<Path::Class> objects as L<Moose> attributes.
-This module constructs coercions (see L<Moose::Util::TypeConstraints>)
+Coercions (see L<Moose::Util::TypeConstraints>) are made
from both 'Str' and 'ArrayRef' to both L<Path::Class::Dir> and
-L<Path::Class::File> objects. It also adds the Getopt option type
-("=s") for both L<Path::Class::Dir> and L<Path::Class::File>
-(see L<MooseX::Getopt>).
+L<Path::Class::File> objects. If you have L<MooseX::Getopt> installed,
+the Getopt option type ("=s") will be added for both
+L<Path::Class::Dir> and L<Path::Class::File>.
-This is just meant to be a central place for these constructs, so you
-don't have to worry about whether they've been created or not, and you're
-not tempted to copy them into yet another class (like I was).
=head1 EXPORTS
-See L<MooseX::Types> for how these exports work.
+None of these are exported by default. They are provided via
+L<MooseX::Types>.
=over
-=item Dir is_Dir to_Dir
+=item Dir, File
+
+These exports can be used instead of the full class names. Example:
+
+ package MyClass;
+ use Moose;
+ use MooseX::Types::Path::Class qw(Dir File);
+
+ has 'dir' => (
+ is => 'ro',
+ isa => Dir,
+ required => 1,
+ coerce => 1,
+ );
+
+ has 'file' => (
+ is => 'ro',
+ isa => File,
+ required => 1,
+ coerce => 1,
+ );
+
+Note that there are no quotes around Dir or File.
+
+=item is_Dir($value), is_File($value)
+
+Returns true or false based on whether $value is a valid Dir or File.
+
+=item to_Dir($value), to_File($value)
-=item File is_File to_File
+Attempts to coerce $value to a Dir or File. Returns the coerced value
+or false if the coercion failed.
=back
=head1 DEPENDENCIES
-L<Moose>, L<MooseX::Types>, L<MooseX::Getopt>, L<Path::Class>
+L<Moose>, L<MooseX::Types>, L<Path::Class>
=head1 BUGS AND LIMITATIONS
-No bugs have been reported.
+If you find a bug please either email the author, or add
+the bug to cpan-RT L<http://rt.cpan.org>.
=head1 AUTHOR
=head1 LICENCE AND COPYRIGHT
-Copyright (c) 2007, Todd Hepler C<< <thepler@employees.org> >>. All rights reserved.
+Copyright (c) 2007-2008, Todd Hepler C<< <thepler@employees.org> >>.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.
projects / gitmo/MooseX-Types-Path-Class.git / blobdiff