/usr/share/perl5/Config/Model/Report.pm is in libconfig-model-perl 2.097-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | #
# This file is part of Config-Model
#
# This software is Copyright (c) 2005-2016 by Dominique Dumont.
#
# This is free software, licensed under:
#
# The GNU Lesser General Public License, Version 2.1, February 1999
#
package Config::Model::Report;
$Config::Model::Report::VERSION = '2.097';
use Carp;
use strict;
use warnings;
use Config::Model::Exception;
use Config::Model::ObjTreeScanner;
use Text::Wrap;
sub new {
bless {}, shift;
}
sub report {
my $self = shift;
my %args = @_;
my $audit = delete $args{audit} || 0;
my $node = delete $args{node}
|| croak "dump_tree: missing 'node' parameter";
my $std_cb = sub {
my ( $scanner, $data_r, $obj, $element, $index, $value_obj ) = @_;
# if element is a collection, get the value pointed by $index
$value_obj = $obj->fetch_element($element)->fetch_with_id($index)
if defined $index;
# get value or only customized value
my $value = $audit ? $value_obj->fetch_custom : $value_obj->fetch;
$value = '"' . $value . '"' if defined $value and $value =~ /\s/;
if ( defined $value ) {
my $name = defined $index ? " $element:$index" : $element;
push @$data_r, $obj->location . " $name = $value";
my $desc = $obj->get_help_as_text($element);
if ( defined $desc and $desc ) {
push @$data_r, wrap( "\t", "\t\t", "DESCRIPTION: $desc" );
}
my $effect = $value_obj->get_help_as_text($value);
if ( defined $effect and $effect ) {
push @$data_r, wrap( "\t", "\t\t", "SELECTED: $effect" );
}
push @$data_r, ''; # to get empty line in report
}
};
my @scan_args = (
fallback => 'all',
auto_vivify => 0,
leaf_cb => $std_cb,
);
my @left = keys %args;
croak "Report: unknown parameter:@left" if @left;
# perform the scan
my $view_scanner = Config::Model::ObjTreeScanner->new(@scan_args);
my @ret;
$view_scanner->scan_node( \@ret, $node );
return join( "\n", @ret );
}
1;
# ABSTRACT: Reports data from config tree
__END__
=pod
=encoding UTF-8
=head1 NAME
Config::Model::Report - Reports data from config tree
=head1 VERSION
version 2.097
=head1 SYNOPSIS
use Config::Model;
# define configuration tree object
my $model = Config::Model->new;
$model->create_config_class(
name => "Foo",
element => [
[qw/foo bar/] => {
type => 'leaf',
value_type => 'string'
},
],
description => [
foo => 'some foo explanation',
bar => 'some bar explanation',
]
);
$model->create_config_class(
name => "MyClass",
element => [
[qw/foo bar/] => {
type => 'leaf',
value_type => 'string'
},
my_enum => {
type => 'leaf',
value_type => 'enum',
choice => [qw/A B C/],
help => {
A => 'first letter',
B => 'second letter',
C => 'third letter',
},
description => 'some letters',
},
hash_of_nodes => {
type => 'hash', # hash id
index_type => 'string',
cargo => {
type => 'node',
config_class_name => 'Foo'
},
},
],
);
my $inst = $model->instance(root_class_name => 'MyClass' );
my $root = $inst->config_root ;
# put data
my $steps = 'foo=FOO my_enum=B hash_of_nodes:fr foo=bonjour -
hash_of_nodes:en foo=hello ';
$root->load( steps => $steps );
print $root->report ;
# foo = FOO
#
# my_enum = B
# DESCRIPTION: some letters
# SELECTED: second letter
#
# hash_of_nodes:en foo = hello
# DESCRIPTION: some foo explanation
#
# hash_of_nodes:fr foo = bonjour
# DESCRIPTION: some foo explanation
=head1 DESCRIPTION
This module is used directly by L<Config::Model::Node> to provide
a human readable report of the configuration. This report includes
the configuration values and (if provided by the model) the description
of the configuration item and their effect.
A C<report> shows C<all> configuration items. An C<audit>
shows only configuration items which are different from their default
value.
=head1 CONSTRUCTOR
=head2 new ( )
No parameter. The constructor should be used only by
L<Config::Model::Node>.
=head1 Methods
=head2 report
Returns a string containing the configuration values and (if provided
by the model) the description of the configuration item and their
effect.
Parameters are:
=over
=item audit
Set to 1 to report only configuration data different from default
values. Default is 0.
=item node
Reference to the L<Config::Model::Node> object that is dumped. All
nodes and leaves attached to this node are also dumped.
=back
=head1 AUTHOR
Dominique Dumont, (ddumont at cpan dot org)
=head1 SEE ALSO
L<Config::Model>,L<Config::Model::Node>,L<Config::Model::Walker>
=head1 AUTHOR
Dominique Dumont
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2005-2016 by Dominique Dumont.
This is free software, licensed under:
The GNU Lesser General Public License, Version 2.1, February 1999
=cut
|