.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "WWW::Mechanize::TreeBuilder 3pm"
.TH WWW::Mechanize::TreeBuilder 3pm "2010-12-16" "perl v5.10.1" "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 \- Module to optimize WWW::Mechanize and HTML::TreeBuilder use
.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{<p>some text</p>}, "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`<p>\*(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 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`<ash@cpan.org>\*(C'\fR
.SH "LICENSE"
.IX Header "LICENSE"
Same as Perl 5.8, or at your option any later version of Perl.