Add test for 'flush_before' option
[catagits/HTML-Zoom.git] / lib / HTML / Zoom / FilterBuilder.pm
index 96ddb8f..50398b3 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 {
@@ -282,6 +286,8 @@ HTML::Zoom::FilterBuilder - Add Filters to a Stream
 
 =head1 SYNOPSIS
 
+Create an L<HTML::Zoom> instance:
+
   use HTML::Zoom;
   my $root = HTML::Zoom
       ->from_html(<<MAIN);
@@ -289,30 +295,61 @@ HTML::Zoom::FilterBuilder - Add Filters to a Stream
     <head>
       <title>Default Title</title>
     </head>
-    <body>
+    <body bad_attr='junk'>
       Default Content
     </body>
   </html>
   MAIN
 
+Create a new attribute on the  C<body> 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<title> 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>Stuff</p>
+      <p>Well Now</p>
+      <p id="p2">Is the Time</p>
   </div>
   BODY
 
-  my $output =  $root
-  ->select('title')
-  ->replace_content('Hello World')
-  ->select('body')
-  ->replace_content($body)
-  ->to_html;
+  $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
@@ -321,8 +358,9 @@ will produce:
     <head>
       <title>Hello World</title>
     </head>
-    <body><div id="stuff">
-      <p>Stuff</p>
+    <body class="main one-column"><div id="stuff">
+      <p class="para">Well Now</p>
+      <p id="p2" class="para">Is the Time</p>
   </div>
   </body>
   </html>
@@ -343,17 +381,45 @@ alter the content of that stream.
 
 This class defines the following public API
 
-=head2 set_attribute
+=head2 set_attribute ( $attr=>value | {name=>$attr,value=>$value} )
 
-    TBD
+Sets an attribute of a given name to a given value for all matching selections.
 
-=head2 add_attribute
+    $html_zoom
+      ->select('p')
+      ->set_attribute(class=>'paragraph')
+      ->select('div')
+      ->set_attribute(name=>'class', value=>'divider');
 
-    TBD
 
-=head2 remove_attribute
+Overrides existing values, if such exist.  When multiple L</set_attribute>
+calls are made against the same or overlapping selection sets, the final
+call wins.
 
-    TBD
+=head2 add_to_attribute ( $attr=>value | {name=>$attr,value=>$value} )
+
+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 ( $attr | {name=>$attr} )
+
+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