aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ManaTools/ConfigReader.pm
blob: a2b174395e83cbcd4cd90bd16704f6cb1548234d (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
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
# vim: set et ts=4 sw=4:
package ManaTools::ConfigReader;
#============================================================= -*-perl-*-

=head1 NAME

    ManaTools::ConfigReader - This module allows to load an XML configuration file

=head1 SYNOPSIS

    use ManaTools::ConfigReader;

    my $settings = new ManaTools::ConfigReader({filNema => $fileName});

=head1 DESCRIPTION

    This module allows to load a configuration file returning a Hash references with its content.


=head1 SUPPORT

You can find documentation for this module with the perldoc command:

    perldoc ManaTools::ConfigReader

=head1 SEE ALSO

    XML::Simple
    ManaTools::MainDisplay


=head1 AUTHOR

    Angelo Naselli <anaselli@linux.it>

=head1 COPYRIGHT and LICENSE

    Copyright 2012-2016, Angelo Naselli.
    Copyright 2012, Steven Tucker.

    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


#Class ConfigReader
package ManaTools::ConfigReader;

use Moose;
use diagnostics;
use XML::Simple;

#=============================================================

=head2 new

=head3 INPUT

    hash ref containing
        fileName: configuration file name

=head3 OUTPUT attributes

    data:    Hash reference containing the configuration read
    catLen:  number of categories found
    modLen:  number of modules found
    currCat: current category
    currMod: current module

=head3 DESCRIPTION

    The constructor just loads the given file and provide accessors.

=cut

#=============================================================

has 'fileName' => (
    is       => 'ro',
    isa      => 'Str',
    required => 1,
);

has 'catLen' => (
    is       => 'rw',
    isa      => 'Int',
    init_arg => undef,
    lazy     => 1,
    default   => -1,
);

has 'modLen' => (
    is        => 'rw',
    isa       => 'Int',
    init_arg  => undef,
    lazy      => 1,
    default   => -1,
);

has 'data' => (
    is       => 'ro',
    isa      => 'HashRef',
    init_arg => undef,
    lazy     => 1,
    builder  => '_dataInitialize',
);

sub _dataInitialize {
    my $self = shift;

    my $xml = new XML::Simple ();
    my $data = $xml->XMLin(
        $self->fileName(),
        ContentKey => '-content',
        ForceArray => ['category', 'title', 'module'],
        KeyAttr=>{
            title => "xml:lang",
        }
    );

    $self->catLen( scalar(@{$data->{category}}) );
    $self->modLen(
        scalar(@{@{$data->{category}}[0]->{module}})
    );

    return $data;
}

has 'currCat' => (
    is        => 'rw',
    isa       => 'Int',
    init_arg  => undef,
    default   => -1,
);

has 'currMod' => (
    is        => 'rw',
    isa       => 'Int',
    init_arg  => undef,
    default   => -1,
);


#=============================================================

=head2 BUILD

=head3 INPUT

    $self: this object

=head3 DESCRIPTION

    The BUILD method is called after a Moose object is created,
    Into this method new optional parameters are tested once,
    instead of into any other methods.

=cut

#=============================================================
sub BUILD {
    my $self = shift;

    die "Given fileName does not exsts" if (! -e $self->fileName);
    # force to read the file now, to make its content available
    $self->data();
}

#=============================================================

=head2 hasNextCat

=head3 INPUT

    $self: this object

=head3 OUTPUT

    1: if there are any other ctegories

=head3 DESCRIPTION

    This method returns if there are any categories left

=cut

#=============================================================
sub hasNextCat {
    my $self = shift;

    if($self->currCat() + 1 >= $self->catLen()) {
        return 0;
    }
    return 1;
}

#=============================================================

=head2 getNextCat

=head3 INPUT

    $self: this object

=head3 OUTPUT

    $cat: next category

=head3 DESCRIPTION

    This method returns the next category

=cut

#=============================================================
sub getNextCat {
    my $self = shift;

    if ($self->hasNextCat()) {
        $self->currCat($self->currCat()+1);
        # Reset the Module Count and Mod length for new Category
        $self->currMod(-1);
        $self->modLen(
            scalar(@{@{$self->data()->{category}}[$self->currCat()]->{module}})
        );

        my $cat = @{$self->data()->{category}}[$self->currCat()];

        return $cat;
    }

    return;
}

#=============================================================

=head2 hasNextMod

=head3 INPUT

    $self: this object

=head3 OUTPUT

    1: if there are any other modules

=head3 DESCRIPTION

    This method returns if there are any modules left

=cut

#=============================================================
sub hasNextMod {
    my $self = shift;

    if($self->currMod() + 1 >= $self->modLen()) {
        return 0;
    }
    return 1;
}

#=============================================================

=head2 getNextMod

=head3 INPUT

    $self: this object

=head3 OUTPUT

    $cat: next module

=head3 DESCRIPTION

    This method returns the next module

=cut

#=============================================================
sub getNextMod {
    my $self = shift;

    my $ret = 0;

    if ($self->hasNextMod()) {
        $self->currMod($self->currMod()+1);
        $ret = @{@{$self->data()->{category} }[$self->currCat()]->{module}}[$self->currMod()];
        return $ret;
    }

    return;
}

no Moose;
1;