The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

PERLANCAR / App-yamlsel-0.009 / README 

            

              
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

              
NAME
    App::yamlsel - Select YAML elements using CSel (CSS-selector-like)
    syntax
VERSION
    This document describes version 0.009 of App::yamlsel (from Perl
    distribution App-yamlsel), released on 2024-07-11.
SYNOPSIS
FUNCTIONS
  yamlsel
    Usage:
     yamlsel(%args) -> [$status_code, $reason, $payload, \%result_meta]
    Select YAML elements using CSel (CSS-selector-like) syntax.
    This function is not exported.
    Arguments ('*' denotes required arguments):
    *   expr => *str*
        (No description)
    *   file => *filename* (default: "-")
        (No description)
    *   node_actions => *array[str]* (default: ["print_as_string"])
        Specify action(s) to perform on matching nodes.
        Each action can be one of the following:
        *   "count" will print the number of matching nodes.
        *   "print_method" will call on or more of the node object's methods
            and print the result. Example:
            print_method:as_string
        *   "dump" will show a indented text representation of the node and
            its descendants. Each line will print information about a single
            node: its class, followed by the value of one or more
            attributes. You can specify which attributes to use in a
            dot-separated syntax, e.g.:
            dump:tag.id.class
            which will result in a node printed like this:
            HTML::Element tag=p id=undef class=undef
        By default, if no attributes are specified, "id" is used. If the
        node class does not support the attribute, or if the value of the
        attribute is undef, then "undef" is shown.
        *   "eval" will execute Perl code for each matching node. The Perl
            code will be called with arguments: "($node)". For convenience,
            $_ is also locally set to the matching node. Example in htmlsel
            you can add this action:
            eval:'print $_->tag'
            which will print the tag name for each matching HTML::Element
            node.
    *   node_actions_on_descendants => *str* (default: "")
        Specify how descendants should be actioned upon.
        This option sets how node action is performed (See "node_actions"
        option).
        When set to '' (the default), then only matching nodes are actioned
        upon.
        When set to 'descendants_depth_first', then after each matching node
        is actioned upon by an action, the descendants of the matching node
        are also actioned, in depth-first order. This option is sometimes
        necessary e.g. when your node's as_string() method shows a node's
        string representation that does not include its descendants.
    *   select_action => *str* (default: "csel")
        Specify how we should select nodes.
        The default is "csel", which will select nodes from the tree using
        the CSel expression. Note that the root node itself is not included.
        For more details on CSel expression, refer to Data::CSel.
        "root" will return a single node which is the root node.
    Returns an enveloped result (an array).
    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.
    Return value: (any)
HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-yamlsel>.
SOURCE
    Source repository is at <https://github.com/perlancar/perl-App-yamlsel>.
AUTHOR
    perlancar <perlancar@cpan.org>
CONTRIBUTING
    To contribute, you can send patches by email/via RT, or send pull
    requests on GitHub.
    Most of the time, you don't need to build the distribution yourself. You
    can simply modify the code, then test via:
     % prove -l
    If you want to build the distribution (e.g. to try to install it locally
    on your system), you can install Dist::Zilla,
    Dist::Zilla::PluginBundle::Author::PERLANCAR,
    Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two
    other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps
    required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
    This software is copyright (c) 2024, 2020, 2019, 2016 by perlancar
    <perlancar@cpan.org>.
    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.
BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=App-yamlsel>
    When submitting a bug or request, please include a test-file or a patch
    to an existing test-file that illustrates the bug or desired feature.