starting to work down the list of methods and figuring out what does what
[catagits/HTML-Zoom.git] / lib / HTML / Zoom / FilterBuilder.pm
index 6e4a37c..7b0eea0 100644 (file)
@@ -42,13 +42,17 @@ 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' })
   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_to_attribute {
   my $self = shift;
   my ($name, $value) = $self->_parse_attribute_args(@_);
   sub {
@@ -275,3 +279,142 @@ 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>Well Now</p>
+      <p>Is the Time</p>
+  </div>
+  BODY
+
+  my $output =  $root
+  ->select('title')
+  ->replace_content('Hello World')
+  ->select('body')
+  ->replace_content($body)
+  ->select('p')
+  ->set_attribute(class=>'para')
+  ->to_html;
+
+will produce:
+
+=begin testinfo
+
+  my $expect = <<HTML;
+
+=end testinfo
+
+  <html>
+    <head>
+      <title>Hello World</title>
+    </head>
+    <body><div id="stuff">
+      <p class="para">Well Now</p>
+      <p class="para">Is the Time</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_to_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
+