made the new FilterBuilder synopsis pass its test
[catagits/HTML-Zoom.git] / lib / HTML / Zoom / FilterBuilder.pm
index 6b50bbb..96ddb8f 100644 (file)
@@ -193,6 +193,20 @@ sub replace {
     my ($evt, $stream) = @_;
     my $emit = $self->_stream_from_proto($replace_with);
     my $coll = &$coll_proto;
+    # if we're replacing the contents of an in place close
+    # then we need to handle that here
+    if ($options->{content}
+        && ref($coll) eq 'HASH'
+        && $coll->{is_in_place_close}
+      ) {
+      my $close = $stream->next;
+      # shallow copy and nuke in place and raw (to force smart print)
+      $_ = { %$_ }, delete @{$_}{qw(is_in_place_close raw)} for ($coll, $close);
+      $emit = $self->_stream_concat(
+                $emit,
+                $self->_stream_from_array($close),
+              );
+    }
     # For a straightforward replace operation we can, in fact, do the emit
     # -before- the collect, and my first cut did so. However in order to
     # use the captured content in generating the new content, we need
@@ -201,9 +215,11 @@ sub replace {
     # for the difference to be noticeable
     return
       ($coll
-        ? (ref $coll eq 'ARRAY'
+        ? (ref $coll eq 'ARRAY' # [ event, stream ]
             ? [ $coll->[0], $self->_stream_concat($coll->[1], $emit) ]
-            : $self->_stream_concat($coll, $emit)
+            : (ref $coll eq 'HASH' # event or stream?
+                 ? [ $coll, $emit ]
+                 : $self->_stream_concat($coll, $emit))
           )
         : $emit
       );
@@ -259,3 +275,138 @@ sub repeat_content {
 }
 
 1;
+
+=head1 NAME
+
+HTML::Zoom::FilterBuilder - Add Filters to a Stream
+
+=head1 SYNOPSIS
+
+  use HTML::Zoom;
+  my $root = HTML::Zoom
+      ->from_html(<<MAIN);
+  <html>
+    <head>
+      <title>Default Title</title>
+    </head>
+    <body>
+      Default Content
+    </body>
+  </html>
+  MAIN
+
+  my $body = HTML::Zoom
+      ->from_html(<<BODY);
+  <div id="stuff">
+      <p>Stuff</p>
+  </div>
+  BODY
+
+  my $output =  $root
+  ->select('title')
+  ->replace_content('Hello World')
+  ->select('body')
+  ->replace_content($body)
+  ->to_html;
+
+will produce:
+
+=begin testinfo
+
+  my $expect = <<HTML;
+
+=end testinfo
+
+  <html>
+    <head>
+      <title>Hello World</title>
+    </head>
+    <body><div id="stuff">
+      <p>Stuff</p>
+  </div>
+  </body>
+  </html>
+
+=begin testinfo
+
+  HTML
+  is($output, $expect, 'Synopsis code works ok');
+
+=end testinfo
+
+=head1 DESCRIPTION
+
+Given a L<HTML::Zoom> 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
+
+    TBD
+
+=head2 add_attribute
+
+    TBD
+
+=head2 remove_attribute
+
+    TBD
+
+=head2 collect
+
+    TBD
+
+=head2 collect_content
+
+    TBD
+
+=head2 add_before
+
+    TBD
+
+=head2 add_after
+
+    TBD
+
+=head2 prepend_content
+
+    TBD
+
+=head2 append_content
+
+    TBD
+
+=head2 replace
+
+    TBD
+
+=head2 replace_content
+
+Given a L<HTML::Zoom/select> result, replace the content with a string, array
+or another L<HTML::Zoom> object.
+
+=head2 repeat
+
+    TBD
+
+=head2 repeat_content
+
+    TBD
+
+=head1 ALSO SEE
+
+L<HTML::Zoom>
+
+=head1 AUTHORS
+
+See L<HTML::Zoom> for authors.
+
+=head1 LICENSE
+
+See L<HTML::Zoom> for the license.
+
+=cut
+