blob: 3297de93a7904d32aae8d33991392c06e28ce577 (
plain)
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
|
# vim: set et ts=4 sw=4:
package ManaTools::ConfigDirRole;
#============================================================= -*-perl-*-
=head1 NAME
Manatools::ConfigDirRole - Role to manage configuration directory
=head1 SYNOPSIS
package Foo;
use Moose;
has 'configDir' => (
...
);
has 'configName' => (
...
);
with 'Manatools::ConfigDirRole';
1;
=head1 DESCRIPTION
ConfigDirRole just define a role in which the config dir is defined in a single point
for all the module that uses it.
=head1 SUPPORT
You can find documentation for this module with the perldoc command:
perldoc Manatools::ConfigDirRole
=head1 SEE ALSO
=head1 AUTHOR
Angelo Naselli <anaselli@linux.it>
=head1 COPYRIGHT and LICENSE
Copyright (C) 2015-2017, Angelo Naselli.
This module is free software. You can redistribute it and/or
modify it under the terms of the Artistic License 2.0.
This program is distributed in the hope that it will be
useful, but without any warranty; without even the implied
warranty of merchantability or fitness for a particular purpose
=cut
use Moose::Role;
=head2 requires
=head3 definitions
configDir: a root directory for configuration, e.g. a path
configName: a name under configDir in which to find configuration file
=cut
#=============================================================
requires 'configDir';
requires 'configName';
has 'defaultConfigDir' => (
is => 'ro',
isa => 'Str',
init_arg => undef,
default => '/etc/manatools',
);
#=============================================================
=head2 configPathName
=head3 INPUT
$self: this object
=head3 DESCRIPTION
return the path name, e.g. configDir/configName
=cut
#=============================================================
sub configPathName {
my $self = shift;
my $dir = $self->configDir() || $self->defaultConfigDir();
chop $dir if substr($dir, -1) eq '/';
return $dir . "/" . $self->configName();
}
no Moose::Role;
1;
|
