Bug #46258 for CGI-Application-Plugin-ValidateRM: Override HTML::FillInForm with subclass

On Wed May 20 17:09:19 2009, mark@summersault.com wrote: Show quoted text
Looking at it, I instead think it should be a $self->param() option like dfv_defaults. I'm attaching a param that allows dfv_fif_class. In addition, this patch adds dfv_fif_defaults, which is a compliment to dfv_defaults. In almost all my uses I find myself doing this every time I use it check_rm() my $results = $self->check_rm('show', $profile, {ignore_fields => ['rm']}) || return $self->check_rm_error_page(); Now instead I can put $self->param(dfv_fif_defaults => { ignore_fields => ['rm'] }) And then never have to worry about it again. Show quoted text
It actually wasn't that hard. Tests attached.

--- lib/CGI/Application/Plugin/ValidateRM.pm.old 2008-10-22 23:06:41.000000000 -0400 +++ lib/CGI/Application/Plugin/ValidateRM.pm 2009-05-21 08:09:45.000000000 -0400 @@ -81,7 +81,10 @@ my $self = shift; my $r = $self->{'__DFV_RESULT'}; my $return_rm = $self->{'__DFV_RETURN_RM'}; - my $fif_params = $self->{'__DFV_FIF_PARAMS'}; + my $fif_params = $self->param('dfv_fif_defaults') || {}; + + # merge the defaults with the ones given for this fill + $fif_params = {%$fif_params, %{$self->{'__DFV_FIF_PARAMS'}}}; my $err_page = undef; if ($r->has_missing or $r->has_invalid) { @@ -95,8 +98,10 @@ my $return_pageref = (ref($return_page) eq 'SCALAR') ? $return_page : \$return_page; - require HTML::FillInForm; - my $fif = new HTML::FillInForm; + + my $fif_class = $self->param('dfv_fif_class') || 'HTML::FillInForm'; + eval "require $fif_class"; + my $fif = $fif_class->new(); $err_page = $fif->fill( scalarref => $return_pageref, fobject => $self->query, @@ -194,10 +199,19 @@ =back -Additionally, the value of the 'dfv_defaults' param from the calling -object is optionally used to pass defaults to the C<new()> constructor. +=head3 Additional Options + +To control things even more, you can set parameters in your L<CGI::Application> +object itself. + +=over + +=item dfv_defaults - $self->param('dfv_defaults') +The value of the 'dfv_defaults' param is optionally used to pass defaults to the +L<Data::FormValidator> C<new()> constructor. + + $self->param(dfv_defaults => { filters => ['trim'] }) By setting this to a hash reference of defaults in your C<cgiapp_init> routine in your own super-class, you could make it easy to share some default settings for @@ -228,6 +242,29 @@ C<cgiapp_init()> routine and have these defaults, so I don't have to add them to every profile. +=item dfv_fif_class + +By default this plugin uses L<HTML::FillInForm> to fill in the forms +on the error pages with the given values. This option let's you change +that so it uses an L<HTML::FillInForm> compatible class (like a subclass) +to do the same work. + + $self->param(dfv_fif_class => 'HTML::FillInForm::SuperDuper'); + +=item dfv_fif_defaults + +The value of the 'dfv_fif_defaults' param is optionally used to pass defaults to the +L<HTML::FillInForm> C<fill()> method. + + $self->param(dfv_fif_defaults => {ignore_fields => ['rm']}) + +By setting this to a hash reference of defaults in your C<cgiapp_init> routine +in your own super-class, you could make it easy to share some default settings for +L<HTML::FillInForm> across several forms. Of course, you could also set parameter +through an instance script via the PARAMS key. + +=back + =head2 CGI::Application::Plugin::Forward support Experimental support has been added for CGI::Application::Plugin::Forward,

use Test::More tests => 3; BEGIN { use_ok('CGI::Application::Plugin::ValidateRM') }; use lib './t'; use strict; $ENV{CGI_APP_RETURN_ONLY} = 1; use CGI; use TestApp1; my $app = TestApp1->new(QUERY=>CGI->new("email=broken;rm=form_process")); my $output = $app->run(); like($output, qr/value="broken"/); $app->param(dfv_fif_defaults => { ignore_fields => ['email'] }); $output = $app->run(); unlike($output, qr/value="broken"/);

use Test::More tests => 3; BEGIN { use_ok('CGI::Application::Plugin::ValidateRM') }; use lib './t'; use strict; $ENV{CGI_APP_RETURN_ONLY} = 1; use CGI; use TestApp1; my $app = TestApp1->new(QUERY=>CGI->new("email=broken;rm=form_process")); my $output = $app->run(); unlike($output, qr/Filler Up/); $app->param(dfv_fif_class => 'TestFormFiller'); $output = $app->run(); like($output, qr/Filler Up/); exit(0); package TestFormFiller; use strict; use warnings; sub new { bless {}, $_[0] } sub fill { "Filler Up!" } 1;

Hi Mark, you wrote some time ago: Show quoted text
So at last, here is my suggestion for the next release: https://github.com/fany/CGI-Application-Plugin-ValidateRM Disclaimer: I merely integrated Michael's work and hope that is OK. If you would still like to grant me co-maintainership, I will upload the new version to CPAN and try to fix future bugs. Kind regards, fany -- ___________________________________________ _ Martin H. Sluka \ mailto:martin@sluka.de / ASCII ribbon ( ) Breite Straße 3 \ tel +49-700-19751024 / campaign - against X D-90552 Röthenbach \-- http://unf.ug ---/ HTML email & vcards / \