From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

SZABGAB / Padre-1.02 / lib / Padre / Config / Human.pm 

            

              
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

              
package Padre::Config::Human;
=pod
=head1 NAME
Padre::Config::Human - Padre configuration for personal preferences
=head1 DESCRIPTION
This class implements the personal preferences of Padre's users. See L<Padre::Config>
for more information on the various types of preferences supported by Padre.
All human settings are stored in a hash as top-level keys (no hierarchy). The hash is
then dumped in F<config.yml>, a L<YAML> file in Padre's preferences directory (see
L<Padre::Config>).
=head1 METHODS
=cut
use 5.008;
use strict;
use warnings;
use Scalar::Util    ();
use Storable        ();
use YAML::Tiny      ();
use Params::Util    ();
use Padre::Constant ();
our $VERSION = '1.02';
=pod
=head2 create
    my $config = Padre::Config::Human->create;
Create and return an empty user configuration. (Almost empty, since it will
still store the configuration schema revision - see L</"version">).
No parameters.
=cut
sub create {
        my $class = shift;
        my $self = bless {}, $class;
        $self->write;
        return $self;
}
=pod
=head2 read
    my $config = Padre::Config::Human->read;
Load & return the user configuration from the YAML file. Return C<undef> in
case of failure.
No parameters.
=cut
sub read {
        my $class = shift;
        # Load the user configuration
        my $hash = {};
        if ( -e Padre::Constant::CONFIG_HUMAN ) {
                $hash = eval { YAML::Tiny::LoadFile(Padre::Constant::CONFIG_HUMAN); };
        }
        unless ( Params::Util::_HASH0($hash) ) {
                return;
        }
        # Create and return the object
        return bless $hash, $class;
}
=head2 write
    $config->write;
(Over-)write user configuration to the YAML file.
No parameters.
=cut
sub write {
        my $self = shift;
        # Save the unblessed clone of the user configuration hash
        YAML::Tiny::DumpFile(
                Padre::Constant::CONFIG_HUMAN,
                $self->as_hash,
        );
        return 1;
}
=pod
=head2 clone
    my $object = $config->clone;
Creates a cloned copy of the configuration object.
=cut
sub clone {
        my $self  = shift;
        my $class = Scalar::Util::blessed($self);
        return bless {%$self}, $class;
}
=pod
=head2 as_hash
    my $hash = $config->as_hash;
Creates a cloned copy of the configuration object as a plain hash reference.
=cut
sub as_hash {
        my $self = shift;
        return Storable::dclone( +{ %$self } );
}
1;
__END__
=pod
=head1 COPYRIGHT & LICENSE
Copyright 2008-2016 The Padre development team as listed in Padre.pm.
This program is free software; you can redistribute it and/or modify it under the
same terms as Perl 5 itself.
=cut
# Copyright 2008-2016 The Padre development team as listed in Padre.pm.
# LICENSE
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl 5 itself.