X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FHTML%2FZoom%2FFilterBuilder.pm;h=3e487674f5f2719a229c802d1d8e7ced312ccee1;hb=2d0662c077bfd275682acfad25d407e0724ec34f;hp=ff074c772e663de16a7e1c42b6abb320c73c3728;hpb=556c861664d09dd27e3a0bf1f3a8ba37a8c22ec2;p=catagits%2FHTML-Zoom.git diff --git a/lib/HTML/Zoom/FilterBuilder.pm b/lib/HTML/Zoom/FilterBuilder.pm index ff074c7..3e48767 100644 --- a/lib/HTML/Zoom/FilterBuilder.pm +++ b/lib/HTML/Zoom/FilterBuilder.pm @@ -1,7 +1,6 @@ package HTML::Zoom::FilterBuilder; -use strict; -use warnings FATAL => 'all'; +use strictures 1; use base qw(HTML::Zoom::SubObject); use HTML::Zoom::CodeStream; @@ -25,6 +24,8 @@ sub _flatten_stream_of_streams { shift->_zconfig->stream_utils->flatten_stream_of_streams(@_) } +sub set_attr { shift->set_attribute(@_); } + sub set_attribute { my $self = shift; my ($name, $value) = $self->_parse_attribute_args(@_); @@ -42,13 +43,28 @@ sub set_attribute { sub _parse_attribute_args { my $self = shift; - # allow ->add_attribute(name => 'value') - # or ->add_attribute({ name => 'name', value => 'value' }) + # allow ->add_to_attribute(name => 'value') + # or ->add_to_attribute({ name => 'name', value => 'value' }) + + die "WARNING: Long form arg (name => 'class', value => 'x') is deprecated" + if(@_ == 1 && $_[0]->{'name'} && $_[0]->{'value'}); my ($name, $value) = @_ > 1 ? @_ : @{$_[0]}{qw(name value)}; return ($name, $self->_zconfig->parser->html_escape($value)); } sub add_attribute { + die "renamed to add_to_attribute. killing this entirely for 1.0"; +} + +sub add_class { shift->add_to_attribute('class',@_) } + +sub remove_class { shift->remove_attribute('class',@_) } + +sub set_class { shift->set_attribute('class',@_) } + +sub set_id { shift->set_attribute('id',@_) } + +sub add_to_attribute { my $self = shift; my ($name, $value) = $self->_parse_attribute_args(@_); sub { @@ -80,6 +96,38 @@ sub remove_attribute { }; } +sub transform_attribute { + my $self = shift; + my ( $name, $code ) = @_ > 1 ? @_ : @{$_[0]}{qw(name code)}; + + sub { + my $evt = $_[0]; + my %a = %{ $evt->{attrs} }; + my @names = @{ $evt->{attr_names} }; + + my $existed_before = exists $a{$name}; + my $v = $code->( $a{$name} ); + my $deleted = $existed_before && ! defined $v; + my $added = ! $existed_before && defined $v; + if( $added ) { + push @names, $name; + $a{$name} = $v; + } + elsif( $deleted ) { + delete $a{$name}; + @names = grep $_ ne $name, @names; + } else { + $a{$name} = $v; + } + +{ %$evt, raw => undef, raw_attrs => undef, + attrs => \%a, + ( $deleted || $added + ? (attr_names => \@names ) + : () ) + } + }; +} + sub collect { my ($self, $options) = @_; my ($into, $passthrough, $content, $filter, $flush_before) = @@ -100,7 +148,20 @@ sub collect { my $name = $evt->{name}; my $depth = 1; my $_next = $content ? 'peek' : 'next'; - $stream = do { local $_ = $stream; $filter->($stream) } if $filter; + if ($filter) { + if ($content) { + $stream = do { local $_ = $stream; $filter->($stream) }; + } else { + $stream = do { + local $_ = $self->_stream_concat( + $self->_stream_from_array($evt), + $stream, + ); + $filter->($_); + }; + $evt = $stream->next; + } + } my $collector = $self->_stream_from_code(sub { return unless $stream; while (my ($evt) = $stream->$_next) { @@ -139,7 +200,21 @@ sub collect_content { sub add_before { my ($self, $events) = @_; - sub { return $self->_stream_from_array(@$events, $_[0]) }; + my $coll_proto = $self->collect({ passthrough => 1 }); + sub { + my $emit = $self->_stream_from_proto($events); + my $coll = &$coll_proto; + if($coll) { + if(ref $coll eq 'ARRAY') { + my $firstbit = $self->_stream_from_proto([$coll->[0]]); + return $self->_stream_concat($emit, $firstbit, $coll->[1]); + } elsif(ref $coll eq 'HASH') { + return [$emit, $coll]; + } else { + return $self->_stream_concat($emit, $coll); + } + } else { return $emit } + } } sub add_after { @@ -147,7 +222,7 @@ sub add_after { my $coll_proto = $self->collect({ passthrough => 1 }); sub { my ($evt) = @_; - my $emit = $self->_stream_from_array(@$events); + my $emit = $self->_stream_from_proto($events); my $coll = &$coll_proto; return ref($coll) eq 'HASH' # single event, no collect ? [ $coll, $emit ] @@ -157,15 +232,18 @@ sub add_after { sub prepend_content { my ($self, $events) = @_; + my $coll_proto = $self->collect({ passthrough => 1, content => 1 }); sub { my ($evt) = @_; + my $emit = $self->_stream_from_proto($events); if ($evt->{is_in_place_close}) { $evt = { %$evt }; delete @{$evt}{qw(raw is_in_place_close)}; return [ $evt, $self->_stream_from_array( - @$events, { type => 'CLOSE', name => $evt->{name} } + $emit->next, { type => 'CLOSE', name => $evt->{name} } ) ]; } - return $self->_stream_from_array($evt, @$events); + my $coll = &$coll_proto; + return [ $coll->[0], $self->_stream_concat($emit, $coll->[1]) ]; }; } @@ -174,14 +252,14 @@ sub append_content { my $coll_proto = $self->collect({ passthrough => 1, content => 1 }); sub { my ($evt) = @_; + my $emit = $self->_stream_from_proto($events); if ($evt->{is_in_place_close}) { $evt = { %$evt }; delete @{$evt}{qw(raw is_in_place_close)}; return [ $evt, $self->_stream_from_array( - @$events, { type => 'CLOSE', name => $evt->{name} } + $emit->next, { type => 'CLOSE', name => $evt->{name} } ) ]; } my $coll = &$coll_proto; - my $emit = $self->_stream_from_array(@$events); return [ $coll->[0], $self->_stream_concat($coll->[1], $emit) ]; }; } @@ -239,7 +317,7 @@ sub repeat { if ($repeat_between) { $options->{filter} = sub { $_->select($repeat_between)->collect({ into => \@between }) - }; + } } my $repeater = sub { my $s = $self->_stream_from_proto($repeat_for); @@ -280,11 +358,407 @@ sub repeat_content { 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"> + <p>Well Now</p> + <p id="p2">Is the Time</p> + </div> + BODY + + $root = $root + ->select('body') + ->replace_content($body); + +Set an attribute on multiple matches: + + $root = $root + ->select('p') + ->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 + + <html> + <head> + <title>Hello World + +
+

Well Now

+

Is the Time

+
+ + + +=begin testinfo + + HTML + is($output, $expect, 'Synopsis code works ok'); + +=end testinfo + =head1 DESCRIPTION Given a L stream, provide methods to apply filters which alter the content of that stream. +=head1 METHODS + +This class defines the following public API + +=head2 set_attribute + +Sets an attribute of a given name to a given value for all matching selections. + + $html_zoom + ->select('p') + ->set_attribute(class=>'paragraph') + ->select('div') + ->set_attribute({class=>'paragraph', name=>'divider'}); + +Overrides existing values, if such exist. When multiple L +calls are made against the same or overlapping selection sets, the final +call wins. + +=head2 add_to_attribute + +Adds a value to an existing attribute, or creates one if the attribute does not +yet exist. You may call this method with either an Array or HashRef of Args. + + $html_zoom + ->select('p') + ->set_attribute({class => 'paragraph', name => 'test'}) + ->then + ->add_to_attribute(class=>'divider'); + +Attributes with more than one value will have a dividing space. + +=head2 remove_attribute + +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 transform_attribute + +Transforms (or creates or deletes) an attribute by running the passed +coderef on it. If the coderef returns nothing, the attribute is +removed. + + $html_zoom + ->select('a') + ->transform_attribute( href => sub { + ( my $a = shift ) =~ s/localhost/example.com/; + return $a; + }, + ); + +=head2 collect + +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 + +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 + +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 + +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 + +Similar to add_before, but adds the content to the match. + + HTML::Zoom + ->from_html(q[

World

]) + ->select('p') + ->prepend_content("Hello ") + ->to_html + + ##

Hello World

+ +Acceptable values are strings, scalar refs and L objects + +=head2 append_content + +Similar to add_after, but adds the content to the match. + + HTML::Zoom + ->from_html(q[

Hello

]) + ->select('p') + ->prepend_content("World") + ->to_html + + ##

Hello World

+ +Acceptable values are strings, scalar refs and L objects + +=head2 replace + +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 + +For a given selection, repeat over transformations, typically for the purposes +of populating lists. Takes either an array of anonymous subroutines or a zoom- +able object consisting of transformation. + +Example of array reference style (when it doesn't matter that all iterations are +pre-generated) + + $zoom->select('table')->repeat([ + map { + my $elem = $_; + sub { + $_->select('td')->replace_content($e); + } + } @list + ]); + +Subroutines would be run with $_ localized to result of L (of +collected elements), and with said result passed as parameter to subroutine. + +You might want to use CodeStream when you don't have all elements upfront + + $zoom->select('.contents')->repeat(sub { + HTML::Zoom::CodeStream->new({ + code => sub { + while (my $line = $fh->getline) { + return sub { + $_->select('.lno')->replace_content($fh->input_line_number) + ->select('.line')->replace_content($line) + } + } + return + }, + }) + }); + +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 + +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 L