From: Nigel Metheringham Date: Thu, 16 Sep 2010 11:17:22 +0000 (+0100) Subject: FilterColumn tweaks - docs and parameter tests X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=eec182b6efc0f565751f2c81ce25ee419ebb133e;p=dbsrgits%2FDBIx-Class-Historic.git FilterColumn tweaks - docs and parameter tests Now throws exception if no filter parameters passed. Documentation tweaked slightly. --- diff --git a/Changes b/Changes index d374507..70cd7f8 100644 --- a/Changes +++ b/Changes @@ -1,12 +1,14 @@ Revision history for DBIx::Class - * New Features + * New Features / Changes - Implemented add_unique_constraints() which delegates to add_unique_constraint() as appropriate - add_unique_constraint() now poparly throws if called with multiple constraint definitions - No longer depend on SQL::Abstract::Limit - DBIC has been doing most of the heavy lifting for a while anyway + - FilterColumn now passes data through when transformations + are not specified rather than throwing an exception. * Fixes - Fixed rels ending with me breaking subqueried limit realiasing diff --git a/lib/DBIx/Class/FilterColumn.pm b/lib/DBIx/Class/FilterColumn.pm index 3c3f04f..196b3ee 100644 --- a/lib/DBIx/Class/FilterColumn.pm +++ b/lib/DBIx/Class/FilterColumn.pm @@ -7,16 +7,19 @@ use base qw/DBIx::Class::Row/; sub filter_column { my ($self, $col, $attrs) = @_; - $self->throw_exception("FilterColumn does not work with InflateColumn") + $self->throw_exception('FilterColumn does not work with InflateColumn') if $self->isa('DBIx::Class::InflateColumn') && defined $self->column_info($col)->{_inflate_info}; $self->throw_exception("No such column $col to filter") unless $self->has_column($col); - $self->throw_exception("filter_column needs attr hashref") + $self->throw_exception('filter_column expects a hashref of filter specifications') unless ref $attrs eq 'HASH'; + $self->throw_exception('An invocation of filter_column() must specify either a filter_from_storage or filter_to_storage') + unless $attrs->{filter_from_storage} || $attrs->{filter_to_storage}; + $self->column_info($col)->{_filter_info} = $attrs; my $acc = $self->column_info($col)->{accessor}; $self->mk_group_accessors(filtered_column => [ (defined $acc ? $acc : $col), $col]); @@ -34,9 +37,8 @@ sub _column_from_storage { return $value unless exists $info->{_filter_info}; my $filter = $info->{_filter_info}{filter_from_storage}; - $self->throw_exception("No filter for $col") unless defined $filter; - return $self->$filter($value); + return defined $filter ? $self->$filter($value) : $value; } sub _column_to_storage { @@ -48,8 +50,8 @@ sub _column_to_storage { return $value unless exists $info->{_filter_info}; my $unfilter = $info->{_filter_info}{filter_to_storage}; - $self->throw_exception("No unfilter for $col") unless defined $unfilter; - return $self->$unfilter($value); + + return defined $unfilter ? $self->$unfilter($value) : $value; } sub get_filtered_column { @@ -188,15 +190,23 @@ be done with L can be done with this component. =head2 filter_column __PACKAGE__->filter_column( colname => { - filter_from_storage => 'method', - filter_to_storage => 'method', + filter_from_storage => 'method'|\&coderef, + filter_to_storage => 'method'|\&coderef, }) -This is the method that you need to call to set up a filtered column. It takes -exactly two arguments; the first being the column name the second being a -C with C and C having -something that can be called as a method. The method will be called with -the value of the column as the first non-C<$self> argument. +This is the method that you need to call to set up a filtered column. It takes +exactly two arguments; the first being the column name the second being a hash +reference with C and C set to either +a method name or a code reference. In either case the filter is invoked as: + + $row_obj->$filter_specification ($value_to_filter) + +with C<$filter_specification> being chosen depending on whether the +C<$value_to_filter> is being retrieved from or written to permanent +storage. + +If a specific directional filter is not specified, the original value will be +passed to/from storage unfiltered. =head2 get_filtered_column @@ -209,3 +219,22 @@ Returns the filtered value of the column $obj->set_filtered_column(colname => 'new_value') Sets the filtered value of the column + +=head1 EXAMPLE OF USE + +Some databases have restrictions on values that can be passed to +boolean columns, and problems can be caused by passing value that +perl considers to be false (such as C). + +One solution to this is to ensure that the boolean values are set +to something that the database can handle - such as numeric zero +and one, using code like this:- + + __PACKAGE__->filter_column( + my_boolean_column => { + filter_to_storage => sub { $_[1] ? 1 : 0 }, + } + ); + +In this case the C is not required, as just +passing the database value through to perl does the right thing. diff --git a/t/row/filter_column.t b/t/row/filter_column.t index e896cc9..4720575 100644 --- a/t/row/filter_column.t +++ b/t/row/filter_column.t @@ -139,4 +139,62 @@ IC_DIE: { } q(Can't filter column after inflate column); } +# test when we do not set both filter_from_storage/filter_to_storage +DBICTest::Schema::Artist->filter_column(rank => { + filter_to_storage => sub { $to_storage_ran++; $_[1] }, +}); +Class::C3->reinitialize(); + +ASYMMETRIC_TO_TEST: { + # initialise value + $artist->rank(20); + $artist->update; + + my $expected_from = $from_storage_ran; + my $expected_to = $to_storage_ran; + + $artist->rank(10); + ok ($artist->is_column_changed ('rank'), 'Column marked as dirty on accessor-set value'); + is ($artist->rank, '10', 'Column set properly'); + is $from_storage_ran, $expected_from, 'from did not run'; + is $to_storage_ran, ++$expected_to, 'to did run'; + + $artist->discard_changes; + + is ($artist->rank, '20', 'Column set properly'); + is $from_storage_ran, $expected_from, 'from did not run'; + is $to_storage_ran, $expected_to, 'to did not run'; +} + +DBICTest::Schema::Artist->filter_column(rank => { + filter_from_storage => sub { $from_storage_ran++; $_[1] }, +}); +Class::C3->reinitialize(); + +ASYMMETRIC_FROM_TEST: { + # initialise value + $artist->rank(23); + $artist->update; + + my $expected_from = $from_storage_ran; + my $expected_to = $to_storage_ran; + + $artist->rank(13); + ok ($artist->is_column_changed ('rank'), 'Column marked as dirty on accessor-set value'); + is ($artist->rank, '13', 'Column set properly'); + is $from_storage_ran, $expected_from, 'from did not run'; + is $to_storage_ran, $expected_to, 'to did not run'; + + $artist->discard_changes; + + is ($artist->rank, '23', 'Column set properly'); + is $from_storage_ran, ++$expected_from, 'from did run'; + is $to_storage_ran, $expected_to, 'to did not run'; +} + +throws_ok { DBICTest::Schema::Artist->filter_column( rank => {} ) } + qr/\QAn invocation of filter_column() must specify either a filter_from_storage or filter_to_storage/, + 'Correctly throws exception for empty attributes' +; + done_testing;