.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "WWW::Mechanize::TreeBuilder 3pm" .TH WWW::Mechanize::TreeBuilder 3pm "2021-01-05" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" WWW::Mechanize::TreeBuilder \- combine WWW::Mechanize and HTML::TreeBuilder in nice ways .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 7 \& use Test::More tests => 2; \& use Test::WWW::Mechanize; \& use WWW::Mechanize::TreeBuilder; \& # or \& # use WWW::Mechanize; \& # or \& # use Test::WWW::Mechanize::Catalyst \*(AqMyApp\*(Aq; \& \& my $mech = Test::WWW::Mechanize\->new; \& # or \& #my $mech = Test::WWW::Mechanize::Catalyst\->new; \& # etc. etc. \& WWW::Mechanize::TreeBuilder\->meta\->apply($mech); \& \& $mech\->get_ok(\*(Aq/\*(Aq); \& is( $mech\->look_down(_tag => \*(Aqp\*(Aq)\->as_trimmed_text, \*(AqSome text\*(Aq, \*(AqIt worked\*(Aq ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module combines WWW::Mechanize and HTML::TreeBuilder. Why? Because I've seen too much code like the following: .PP .Vb 1 \& like($mech\->content, qr{
some text
}, "Found the right tag"); .Ve .PP Which is just all flavours of wrong \- its akin to processing \s-1XML\s0 with regexps. Instead, do it like the following: .PP .Vb 1 \& ok($mech\->look_down(_tag => \*(Aqp\*(Aq, sub { $_[0]\->as_trimmed_text eq \*(Aqsome text\*(Aq }) .Ve .PP The anon-sub there is a bit icky, but this means that anyone should happen to add attributes to the \f(CW\*(C`\*(C'\fR tag (such as an id or a class) it will still
work and find the right tag.
.PP
All of the methods available on HTML::Element (that aren't 'private' \- i.e.
that don't begin with an underscore) such as \f(CW\*(C`look_down\*(C'\fR or \f(CW\*(C`find\*(C'\fR are
automatically delegated to \f(CW\*(C`$mech\->tree\*(C'\fR through the magic of Moose.
.SH "METHODS"
.IX Header "METHODS"
Everything in WWW::Mechanize (or which ever sub class you apply it to) and
all public methods from HTML::Element except those where WWW::Mechanize and
HTML::Element overlap. In the case where the two classes both define a method,
the one from WWW::Mechanize will be used (so that the existing behaviour of
Mechanize doesn't break.)
.SH "USING XPATH OR OTHER SUBCLASSES"
.IX Header "USING XPATH OR OTHER SUBCLASSES"
HTML::TreeBuilder::XPath allows you to use xpath selectors to select
elements in the tree. You can use that module by providing parameters to the
moose role:
.PP
.Vb 3
\& with \*(AqWWW::Mechanize::TreeBuilder\*(Aq => {
\& tree_class => \*(AqHTML::TreeBuilder::XPath\*(Aq
\& };
\&
\& # or
\&
\& # NOTE: No hashref using this method
\& WWW::Mechanize::TreeBuilder\->meta\->apply($mech,
\& tree_class => \*(AqHTML::TreeBuilder::XPath\*(Aq;
\& );
.Ve
.PP
and class will be automatically loaded for you. This class will be used to
construct the tree in the following manner:
.PP
.Vb 1
\& $tree = $tree_class\->new_from_content($req\->decoded_content)\->elementify;
.Ve
.PP
You can also specify a \f(CW\*(C`element_class\*(C'\fR parameter which is the (HTML::Element
sub)class that methods are proxied from. This module provides defaults for
element_class when \f(CW\*(C`tree_class\*(C'\fR is \*(L"HTML::TreeBuilder\*(R" or
\&\*(L"HTML::TreeBuilder::XPath\*(R" \- it will warn otherwise.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ash Berlin \f(CW\*(C`