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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
# vim: set et ts=4 sw=4:
package ManaTools::Shared::PropertiesRole;
#============================================================= -*-perl-*-
=head1 NAME
ManaTools::Shared::PropertiesRole - a Properties Moose::Role
=head1 SYNOPSIS
package Foo;
with 'ManaTools::Shared::PropertiesRole';
1;
...
my $f = Foo->new();
my @props = $f->properties();
my $vendor = $f->prop('vendor');
$f->prop('vendor', 'myself');
$f->remove('vendor');
$f->prop_from_file('vendor', '/sys/bus/scsi/2:0:0:0/vendor');
=head1 DESCRIPTION
This Role is a collection of Properties
=head1 SUPPORT
You can find documentation for this Role with the perldoc command:
perldoc ManaTools::Shared::PropertiesRole
=head1 AUTHOR
Maarten Vanraes <alien@rmail.be>
=head1 COPYRIGHT and LICENSE
Copyright (c) 2015 Maarten Vanraes <alien@rmail.be>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2, as
published by the Free Software Foundation.
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. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
=head1 METHODS
=cut
use Moose::Role;
has 'props', is => 'ro', isa => 'HashRef[Item]', lazy => 1, default => sub {return {};};
#=============================================================
=head2 properties
=head3 OUTPUT
array of string
=head3 DESCRIPTION
this method returns a list of Property keys
=cut
#=============================================================
sub properties {
my $self = shift;
return keys %{$self->props()};
}
#=============================================================
=head2 has_prop
=head3 INPUT
$key: string
=head3 OUTPUT
1 if Property is assigned, 0 otherwise
=head3 DESCRIPTION
this method checks if it has the properties assigned
=cut
#=============================================================
sub has_prop {
my $self = shift;
my $key = shift;
return defined $self->props()->{$key};
}
#=============================================================
=head2 prop
=head3 INPUT
$key: string
$value: optional value to set
=head3 OUTPUT
value of the Property
=head3 DESCRIPTION
this method gets the value of a Property and optionally sets it
=cut
#=============================================================
sub prop {
my $self = shift;
my $key = shift;
my $value = shift;
if (defined $value) {
$self->props()->{$key} = $value;
}
if (defined $self->props()->{$key}) {
return $self->props()->{$key};
}
return undef;
}
#=============================================================
=head2 prop_from_file
=head3 INPUT
$key: string
$file: file with value to set
=head3 OUTPUT
value of the Property, or undef if failed
=head3 DESCRIPTION
this method sets the value of a Property from a file and returns the value
=cut
#=============================================================
sub prop_from_file {
my $self = shift;
my $key = shift;
my $file = shift;
open F, '<'. $file or return undef;
my $value = <F>;
close F;
chomp($value);
return $self->prop($key, $value);
}
#=============================================================
=head2 remove
=head3 INPUT
$key: string
=head3 DESCRIPTION
this method removes a property
=cut
#=============================================================
sub remove {
my $self = shift;
my $key = shift;
delete $self->props()->{$key};
}
1;
|
