made the new FilterBuilder synopsis pass its test
[catagits/HTML-Zoom.git] / lib / HTML / Zoom / FilterBuilder.pm
index bdfb920..96ddb8f 100644 (file)
@@ -21,9 +21,13 @@ sub _stream_concat {
   shift->_zconfig->stream_utils->stream_concat(@_)
 }
 
+sub _flatten_stream_of_streams {
+  shift->_zconfig->stream_utils->flatten_stream_of_streams(@_)
+}
+
 sub set_attribute {
-  my ($self, $args) = @_;
-  my ($name, $value) = @{$args}{qw(name value)};
+  my $self = shift;
+  my ($name, $value) = $self->_parse_attribute_args(@_);
   sub {
     my $a = (my $evt = $_[0])->{attrs};
     my $e = exists $a->{$name};
@@ -36,9 +40,17 @@ sub set_attribute {
    };
 }
 
+sub _parse_attribute_args {
+  my $self = shift;
+  # allow ->add_attribute(name => 'value')
+  #    or ->add_attribute({ name => 'name', value => 'value' })
+  my ($name, $value) = @_ > 1 ? @_ : @{$_[0]}{qw(name value)};
+  return ($name, $self->_zconfig->parser->html_escape($value));
+}
+
 sub add_attribute {
-  my ($self, $args) = @_;
-  my ($name, $value) = @{$args}{qw(name value)};
+  my $self = shift;
+  my ($name, $value) = $self->_parse_attribute_args(@_);
   sub {
     my $a = (my $evt = $_[0])->{attrs};
     my $e = exists $a->{$name};
@@ -56,7 +68,7 @@ sub add_attribute {
 
 sub remove_attribute {
   my ($self, $args) = @_;
-  my $name = $args->{name};
+  my $name = (ref($args) eq 'HASH') ? $args->{name} : $args;
   sub {
     my $a = (my $evt = $_[0])->{attrs};
     return $evt unless exists $a->{$name};
@@ -70,8 +82,8 @@ sub remove_attribute {
 
 sub collect {
   my ($self, $options) = @_;
-  my ($into, $passthrough, $content, $filter) =
-    @{$options}{qw(into passthrough content filter)};
+  my ($into, $passthrough, $content, $filter, $flush_before) =
+    @{$options}{qw(into passthrough content filter flush_before)};
   sub {
     my ($evt, $stream) = @_;
     # We wipe the contents of @$into here so that other actions depending
@@ -107,7 +119,16 @@ sub collect {
       }
       die "Never saw closing </${name}> before end of source";
     });
-    return ($passthrough||$content) ? [ $evt, $collector ] : $collector;
+    if ($flush_before) {
+      if ($passthrough||$content) {
+        $evt = { %$evt, flush => 1 };
+      } else {
+        $evt = { type => 'EMPTY', flush => 1 };
+      }
+    }
+    return ($passthrough||$content||$flush_before)
+             ? [ $evt, $collector ]
+             : $collector;
   };
 }
 
@@ -172,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
@@ -180,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
       );
@@ -211,23 +248,23 @@ sub repeat {
     # hasn't been populated yet - but we can test @between in the
     # map routine because it has been by then and that saves us doing
     # the extra stream construction if we don't need it.
-    if ($repeat_between) {
-      $s->map(sub {
-            local $_ = $self->_stream_from_array(@into);
-            (@between && $s->peek)
-              ? $self->_stream_concat(
-                  $_[0]->($_), $self->_stream_from_array(@between)
-                )
-              : $_[0]->($_)
-          })
-        ->flatten;
-    } else {
-      $s->map(sub {
-            local $_ = $self->_stream_from_array(@into);
-            $_[0]->($_)
+    $self->_flatten_stream_of_streams(do {
+      if ($repeat_between) {
+        $s->map(sub {
+              local $_ = $self->_stream_from_array(@into);
+              (@between && $s->peek)
+                ? $self->_stream_concat(
+                    $_[0]->($_), $self->_stream_from_array(@between)
+                  )
+                : $_[0]->($_)
+            })
+      } else {
+        $s->map(sub {
+              local $_ = $self->_stream_from_array(@into);
+              $_[0]->($_)
           })
-        ->flatten;
-    }
+      }
+    })
   };
   $self->replace($repeater, $options);
 }
@@ -238,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
+