Extended HTMLScrubber functionality

Author: nigelm

lib/HTML/FormFu/Filter/HTMLScrubber.pm

@@ -7,7 +7,7 @@ use mro 'c3';
 
 use Clone ();
 
-__PACKAGE__->mk_accessors(qw( allow ));
+__PACKAGE__->mk_accessors(qw( allow comment default rules script ));
 
 use HTML::Scrubber;
 
@@ -16,9 +16,13 @@ sub filter {
 
     return if !defined $value;
 
-    my $allowed = $self->allow || [];
+    my %params = ( allow => 0 );
+    foreach (qw(allow comment default rules script)) {
+        my $val = $self->$_;
+        $params{$_} = $val if ( defined($val) );
+    }
 
-    my $scrubber = HTML::Scrubber->new( allow => $allowed );
+    my $scrubber = HTML::Scrubber->new(%params);
 
     return $scrubber->scrub($value);
 }
@@ -46,10 +50,21 @@ HTML::FormFu::Filter::HTMLScrubber - filter removing HTML markup
 
 Remove HTML markup using L<HTML::Scrubber>.
 
+All the functionality of L<HTML::Scrubber> can be accessed using
+this module, other than the C<process> directive (which has a name
+clash with the L<HTML::FormFu::Filter> framework).
+
+For details of the filtering functionality see
+L<HTML::Scrubber/allow>, L<HTML::Scrubber/comment>,
+L<HTML::Scrubber/default>, L<HTML::Scrubber/rules> and
+L<HTML::Scrubber/script>
+
 =head1 AUTHOR
 
 Carl Franks, C<[email protected]>
 
+Extended by Nigel Metheringham, C<[email protected]>
+
 Based on the original source code of L<HTML::Widget::Filter::HTMLStrip>, by 
 Lyo Kato, C<[email protected]>
 

t/filters/htmlscrubber.t

@@ -1,24 +1,29 @@
 use strict;
 use warnings;
 
-use Test::More tests => 4;
+use Test::More tests => 6;
 
 use HTML::FormFu;
 
 my $form = HTML::FormFu->new;
 
 $form->element('Text')->name('foo')->filter('HTMLScrubber');
 $form->element('Text')->name('bar')->filter('HTMLScrubber')->allow( ['b'] );
+$form->element('Text')->name('fum')->filter('HTMLScrubber')->rules( '*' => 0, p => { '*' => 0 }, a => { href => 1, '*' => 0 } );
 
 my $original_foo = "<p>message</p>";
 my $filtered_foo = "message";
 
 my $original_bar = "<p><b>message</b></p>";
 my $filtered_bar = "<b>message</b>";
 
+my $original_fum = "<p class=\"y\"><b>message</b><a href=\"#somewhere\" class=\"x\">text</a></p>";
+my $filtered_fum = "<p>message<a href=\"#somewhere\">text</a></p>";
+
 $form->process( {
         foo => $original_foo,
         bar => $original_bar,
+        fum => $original_fum,
     } );
 
 # foo is quoted
@@ -29,3 +34,7 @@ is( $form->params->{foo}, $filtered_foo, 'foo filtered' );
 is( $form->param('bar'),  $filtered_bar, 'bar filtered' );
 is( $form->params->{bar}, $filtered_bar, 'bar filtered' );
 
+# fum is filtered
+is( $form->param('fum'),  $filtered_fum, 'fum filtered' );
+is( $form->params->{fum}, $filtered_fum, 'fum filtered' );
+