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

ROBINS / XML-Rabbit-0.4.1 / lib / XML / Rabbit / Trait / XPathValueMap.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

              
use strict;
use warnings;
package XML::Rabbit::Trait::XPathValueMap;
$XML::Rabbit::Trait::XPathValueMap::VERSION = '0.4.1';
use Moose::Role;
with 'XML::Rabbit::Trait::XPath';
# ABSTRACT: Multiple value xpath extractor trait
around '_process_options' => sub {
    my ($orig, $self, $name, $options, @rest) = @_;
    $self->$orig($name, $options, @rest);
    # This should really be:
    # has '+isa' => ( required => 1 );
    # but for some unknown reason Moose doesn't allow that
    confess("isa attribute is required") unless defined( $options->{'isa'} );
};
has 'xpath_key' => (
    is       => 'ro',
    isa      => 'Str',
    required => 1,
);
has 'xpath_value' => (
    is       => 'ro',
    isa      => 'Str',
    required => 1,
);
sub _build_default {
    my ($self) = @_;
    return sub {
        my ($parent) = @_;
        my $xpath_query = $self->_resolve_xpath_query( $parent );
        my %node_map;
        foreach my $node ( $self->_find_nodes( $parent, $xpath_query ) ) {
            my $key = $parent->xpc->findvalue( $self->xpath_key, $node );
            if ( defined($key) and length $key > 0 ) {
                my $value = $parent->xpc->findvalue( $self->xpath_value, $node );
                $node_map{$key} = $value;
            }
        }
        return \%node_map;
    };
}
Moose::Util::meta_attribute_alias('XPathValueMap');
no Moose::Role;
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
XML::Rabbit::Trait::XPathValueMap - Multiple value xpath extractor trait
=head1 VERSION
version 0.4.1
=head1 SYNOPSIS
    package MyXMLSyntaxNode;
    use Moose;
    with 'XML::Rabbit::RootNode';
    has reference_map => (
        isa         => 'HashRef[Str]',
        traits      => [qw(XPathValueMap)],
        xpath_query => '//*[@href]',
        xpath_key   => './@href',
        xpath_value => './@title';
    );
    no Moose;
    __PACKAGE__->meta->make_immutable();
    1;
=head1 DESCRIPTION
This module provides the extraction of primitive values from an XML node based on an XPath query.
See L<XML::Rabbit> for a more complete example.
=head1 ATTRIBUTES
=head2 xpath_key
The xpath query that specifies what will be put in the key in the hash. Required.
=head2 xpath_value
The xpath query that specifies what will be put in the value in the hash. Required.
=head1 METHODS
=head2 _build_default
Returns a coderef that is run to build the default value of the parent attribute. Read Only.
=head1 AUTHOR
Robin Smidsrød <robin@smidsrod.no>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Robin Smidsrød.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut