X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FHTML%2FZoom%2FFilterBuilder.pm;h=a90a987aaea626450fe067725ad06f00fcc0d91a;hb=ac3acd87cf286ac9be7fe0969e71f1fe1beccfe3;hp=58237ca170028db9bec6e8778545f20ad218e780;hpb=f8ad684db84b3770391673ec6e740db8e8d2f994;p=catagits%2FHTML-Zoom.git diff --git a/lib/HTML/Zoom/FilterBuilder.pm b/lib/HTML/Zoom/FilterBuilder.pm index 58237ca..a90a987 100644 --- a/lib/HTML/Zoom/FilterBuilder.pm +++ b/lib/HTML/Zoom/FilterBuilder.pm @@ -286,6 +286,8 @@ HTML::Zoom::FilterBuilder - Add Filters to a Stream =head1 SYNOPSIS +Create an L instance: + use HTML::Zoom; my $root = HTML::Zoom ->from_html(< Default Title - + Default Content MAIN +Create a new attribute on the C tag: + + $root = $root + ->select('body') + ->set_attribute(class=>'main'); + +Add a extra value to an existing attribute: + + $root = $root + ->select('body') + ->add_to_attribute(class=>'one-column'); + +Set the content of the C tag: + + $root = $root + ->select('title') + ->replace_content('Hello World'); + +Set content from another L<HTML::Zoom> instance: + my $body = HTML::Zoom ->from_html(<<BODY); <div id="stuff"> @@ -307,23 +329,27 @@ HTML::Zoom::FilterBuilder - Add Filters to a Stream </div> BODY - my $output = $root - ->select('title') - ->replace_content('Hello World') + $root = $root ->select('body') - ->replace_content($body) - ->then - ->set_attribute(class=>'main') + ->replace_content($body); + +Set an attribute on multiple matches: + + $root = $root ->select('p') - ->set_attribute(class=>'para') - ->select('#p2') - ->set_attribute(class=>'para2') - ->to_html; + ->set_attribute(class=>'para'); + +Remove an attribute: + + $root = $root + ->select('body') + ->remove_attribute('bad_attr'); will produce: =begin testinfo + my $output = $root->to_html; my $expect = <<HTML; =end testinfo @@ -332,9 +358,9 @@ will produce: <head> <title>Hello World -

Well Now

Is the Time

@@ -363,7 +389,8 @@ Sets an attribute of a given name to a given value for all matching selections. ->select('p') ->set_attribute(class=>'paragraph') ->select('div') - ->set_attribute(name=>'class', value=>'divider') + ->set_attribute(name=>'class', value=>'divider'); + Overrides existing values, if such exist. When multiple L calls are made against the same or overlapping selection sets, the final @@ -371,27 +398,156 @@ call wins. =head2 add_to_attribute - TBD +Adds a value to an existing attribute, or creates one if the attribute does not +yet exist. + + $html_zoom + ->select('p') + ->set_attribute(class=>'paragraph') + ->then + ->add_to_attribute(name=>'class', value=>'divider'); + +Attributes with more than one value will have a dividing space. =head2 remove_attribute - TBD +Removes an attribute and all its values. + + $html_zoom + ->select('p') + ->set_attribute(class=>'paragraph') + ->then + ->remove_attribute('class'); + +Removes attributes from the original stream or events already added. =head2 collect - TBD +Collects and extracts results of L. It takes the following +optional common options as hash reference. + +=over + +=item into [ARRAY REFERENCE] + +Where to save collected events (selected elements). + + $z1->select('#main-content') + ->collect({ into => \@body }) + ->run; + $z2->select('#main-content') + ->replace(\@body) + ->memoize; + +=item filter [CODE] + +Run filter on collected elements (locally setting $_ to stream, and passing +stream as an argument to given code reference). Filtered stream would be +returned. + + $z->select('.outer') + ->collect({ + filter => sub { $_->select('.inner')->replace_content('bar!') }, + passthrough => 1, + }) + +It can be used to further filter selection. For example + + $z->select('tr') + ->collect({ + filter => sub { $_->select('td') }, + passthrough => 1, + }) + +is equivalent to (not implemented yet) descendant selector combination, i.e. + + $z->select('tr td') + +=item passthrough [BOOLEAN] + +Extract copy of elements; the stream is unchanged (it does not remove collected +elements). For example without 'passthrough' + + HTML::Zoom->from_html('') + ->select('foo') + ->collect({ content => 1 }) + ->to_html + +returns '', while with C option + + HTML::Zoom->from_html('') + ->select('foo') + ->collect({ content => 1, passthough => 1 }) + ->to_html + +returns ''. + +=item content [BOOLEAN] + +Collect content of the element, and not the element itself. + +For example + + HTML::Zoom->from_html('

Title

foo

') + ->select('h1') + ->collect + ->to_html + +would return '

foo

', while + + HTML::Zoom->from_html('

Title

foo

') + ->select('h1') + ->collect({ content => 1 }) + ->to_html + +would return '

foo

'. + +See also L. + +=item flush_before [BOOLEAN] + +Generate C event before collecting, to ensure that the HTML generated up +to selected element being collected is flushed throught to the browser. Usually +used in L or L. + +=back =head2 collect_content - TBD +Collects contents of L result. + + HTML::Zoom->from_file($foo) + ->select('#main-content') + ->collect_content({ into => \@foo_body }) + ->run; + $z->select('#foo') + ->replace_content(\@foo_body) + ->memoize; + +Equivalent to running L with C option set. =head2 add_before - TBD +Given a L result, add given content (which might be string, +array or another L object) before it. + + $html_zoom + ->select('input[name="foo"]') + ->add_before(\ 'required field'); =head2 add_after - TBD +Like L, only after L result. + + $html_zoom + ->select('p') + ->add_after("\n\n"); + +You can add zoom events directly + + $html_zoom + ->select('p') + ->add_after([ { type => 'TEXT', raw => 'O HAI' } ]); =head2 prepend_content @@ -403,20 +559,101 @@ call wins. =head2 replace - TBD +Given a L result, replace it with a string, array or another +L object. It takes the same optional common options as L +(via hash reference). =head2 replace_content Given a L result, replace the content with a string, array or another L object. + $html_zoom + ->select('title, #greeting') + ->replace_content('Hello world!'); + =head2 repeat - TBD + $zoom->select('.item')->repeat(sub { + if (my $row = $db_thing->next) { + return sub { $_->select('.item-name')->replace_content($row->name) } + } else { + return + } + }, { flush_before => 1 }); + +Run I<$repeat_for>, which should be iterator (code reference) returning +subroutines, reference to array of subroutines, or other zoom-able object +consisting of transformations. Those subroutines would be run with $_ +local-ized to result of L (of collected elements), and with +said result passed as parameter to subroutine. + +You might want to use iterator when you don't have all elements upfront + + $zoom = $zoom->select('.contents')->repeat(sub { + while (my $line = $fh->getline) { + return sub { + $_->select('.lno')->replace_content($fh->input_line_number) + ->select('.line')->replace_content($line) + } + } + return + }); + +You might want to use array reference if it doesn't matter that all iterations +are pre-generated + + $zoom->select('table')->repeat([ + map { + my $elem = $_; + sub { + $_->select('td')->replace_content($e); + } + } @list + ]); + +In addition to common options as in L, it also supports + +=over + +=item repeat_between [SELECTOR] + +Selects object to be repeated between items. In the case of array this object +is put between elements, in case of iterator it is put between results of +subsequent iterations, in the case of streamable it is put between events +(->to_stream->next). + +See documentation for L + +=back =head2 repeat_content - TBD +Given a L result, run provided iterator passing content of +this result to this iterator. Accepts the same options as L. + +Equivalent to using C option with L. + + $html_zoom + ->select('#list') + ->repeat_content( + [ + sub { + $_->select('.name')->replace_content('Matt') + ->select('.age')->replace_content('26') + }, + sub { + $_->select('.name')->replace_content('Mark') + ->select('.age')->replace_content('0x29') + }, + sub { + $_->select('.name')->replace_content('Epitaph') + ->select('.age')->replace_content('') + }, + ], + { repeat_between => '.between' } + ); + =head1 ALSO SEE