1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
NAME
Types::Path::Tiny - Path::Tiny types and coercions for Moose and Moo
VERSION
version 0.006
SYNOPSIS
Example with Moose:
### specification of type constraint with coercion
package Foo;
use Moose;
use Types::Path::Tiny qw/Path AbsPath/;
has filename => (
is => 'ro',
isa => Path,
coerce => 1,
);
has directory => (
is => 'ro',
isa => AbsPath,
coerce => 1,
);
### usage in code
Foo->new( filename => 'foo.txt' ); # coerced to Path::Tiny
Foo->new( directory => '.' ); # coerced to path('.')->absolute
Example with Moo:
### specification of type constraint with coercion
package Foo;
use Moo;
use Types::Path::Tiny qw/Path AbsPath/;
has 'directory' => (
is => 'rw',
isa => AbsPath,
required => 1,
coerce => AbsPath->coercion,
);
### usage in code
Foo->new( directory => '.' ); # coerced to path('.')->absolute
DESCRIPTION
This module provides Path::Tiny types for Moose, Moo, etc.
It handles two important types of coercion:
* coercing objects with overloaded stringification
* coercing to absolute paths
It also can check to ensure that files or directories exist.
SUBTYPES
This module uses Type::Tiny to define the following subtypes.
Path
"Path" ensures an attribute is a Path::Tiny object. Strings and objects
with overloaded stringification may be coerced.
AbsPath
"AbsPath" is a subtype of "Path" (above), but coerces to an absolute
path.
File, AbsFile
These are just like "Path" and "AbsPath", except they check "-f" to
ensure the file actually exists on the filesystem.
Dir, AbsDir
These are just like "Path" and "AbsPath", except they check "-d" to
ensure the directory actually exists on the filesystem.
CAVEATS
Path vs File vs Dir
"Path" just ensures you have a Path::Tiny object.
"File" and "Dir" check the filesystem. Don't use them unless that's
really what you want.
Usage with File::Temp
Be careful if you pass in a File::Temp object. Because the argument is
stringified during coercion into a Path::Tiny object, no reference to
the original File::Temp argument is held. Be sure to hold an external
reference to it to avoid immediate cleanup of the temporary file or
directory at the end of the enclosing scope.
A better approach is to use Path::Tiny's own "tempfile" or "tempdir"
constructors, which hold the reference for you.
Foo->new( filename => Path::Tiny->tempfile );
SEE ALSO
* Path::Tiny
* Moose::Manual::Types
SUPPORT
Bugs / Feature Requests
Please report any bugs or feature requests through the issue tracker at
<https://github.com/dagolden/types-path-tiny/issues>. You will be
notified automatically of any progress on your issue.
Source Code
This is open source software. The code repository is available for
public review and contribution under the terms of the license.
<https://github.com/dagolden/types-path-tiny>
git clone https://github.com/dagolden/types-path-tiny.git
AUTHOR
David Golden <dagolden@cpan.org>
CONTRIBUTORS
* Hobbestigrou <hobbestigrou@erakis.eu>
* Hobbestigrou <natal.ngetal@novapost.fr>
* Toby Inkster <tobyink@cpan.org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2013 by David Golden.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
|
