X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FFilterColumn.pm;h=45b798c0f643ee50d3b6f9936e3396f8294d22bf;hb=a5722c7269d6eec8621964686e52268b5a8a34aa;hp=0cfcdfcf0d8d1dbb841173ba9a31f545d8da563b;hpb=22d9e05a39b5afbac794a5af9e83b4a38f766ac4;p=dbsrgits%2FDBIx-Class.git

diff --git a/lib/DBIx/Class/FilterColumn.pm b/lib/DBIx/Class/FilterColumn.pm
index 0cfcdfc..45b798c 100644
--- a/lib/DBIx/Class/FilterColumn.pm
+++ b/lib/DBIx/Class/FilterColumn.pm
@@ -1,5 +1,4 @@
 package DBIx::Class::FilterColumn;
-
 use strict;
 use warnings;
 
@@ -8,6 +7,10 @@ use base qw/DBIx::Class::Row/;
 sub filter_column {
   my ($self, $col, $attrs) = @_;
 
+  $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);
 
@@ -21,7 +24,7 @@ sub filter_column {
 }
 
 sub _column_from_storage {
-  my ($self, $source, $col, $value) = @_;
+  my ($self, $col, $value) = @_;
 
   return $value unless defined $value;
 
@@ -31,13 +34,13 @@ sub _column_from_storage {
   return $value unless exists $info->{_filter_info};
 
   my $filter = $info->{_filter_info}{filter_from_storage};
-  $self->throw_exception("No inflator for $col") unless defined $filter;
+  $self->throw_exception("No filter for $col") unless defined $filter;
 
-  return $source->$filter($value);
+  return $self->$filter($value);
 }
 
 sub _column_to_storage {
-  my ($self, $source, $col, $value) = @_;
+  my ($self, $col, $value) = @_;
 
   my $info = $self->column_info($col) or
     $self->throw_exception("No column info for $col");
@@ -46,7 +49,7 @@ sub _column_to_storage {
 
   my $unfilter = $info->{_filter_info}{filter_to_storage};
   $self->throw_exception("No unfilter for $col") unless defined $unfilter;
-  return $source->$unfilter($value);
+  return $self->$unfilter($value);
 }
 
 sub get_filtered_column {
@@ -60,84 +63,143 @@ sub get_filtered_column {
 
   my $val = $self->get_column($col);
 
-  return $self->{_filtered_column}{$col} = $self->_column_from_storage($self->result_source, $col, $val);
+  return $self->{_filtered_column}{$col} = $self->_column_from_storage($col, $val);
+}
+
+sub get_column {
+  my ($self, $col) = @_;
+  if (exists $self->{_filtered_column}{$col}) {
+    return $self->{_column_data}{$col} ||= $self->_column_to_storage ($col, $self->{_filtered_column}{$col});
+  }
+
+  return $self->next::method ($col);
+}
+
+# sadly a separate codepath in Row.pm ( used by insert() )
+sub get_columns {
+  my $self = shift;
+
+  foreach my $col (keys %{$self->{_filtered_column}||{}}) {
+    $self->{_column_data}{$col} ||= $self->_column_to_storage ($col, $self->{_filtered_column}{$col})
+      if exists $self->{_filtered_column}{$col};
+  }
+
+  $self->next::method (@_);
+}
+
+sub store_column {
+  my ($self, $col) = (shift, @_);
+
+  # blow cache
+  delete $self->{_filtered_column}{$col};
+
+  $self->next::method(@_);
 }
 
 sub set_filtered_column {
   my ($self, $col, $filtered) = @_;
 
-  $self->set_column($col, $self->_column_to_storage($self->result_source, $col, $filtered));
+  # do not blow up the cache via set_column unless necessary
+  # (filtering may be expensive!)
+  if (exists $self->{_filtered_column}{$col}) {
+    return $filtered
+      if ($self->_eq_column_values ($col, $filtered, $self->{_filtered_column}{$col} ) );
 
-  delete $self->{_filtered_column}{$col};
+    $self->make_column_dirty ($col); # so the comparison won't run again
+  }
+
+  $self->set_column($col, $self->_column_to_storage($col, $filtered));
 
-  return $filtered;
+  return $self->{_filtered_column}{$col} = $filtered;
 }
 
 sub update {
   my ($self, $attrs, @rest) = @_;
+
   foreach my $key (keys %{$attrs||{}}) {
-    if ($self->has_column($key) &&
-          exists $self->column_info($key)->{_filter_info}) {
-      my $val = delete $attrs->{$key};
-      $self->set_filtered_column($key, $val);
-      $attrs->{$key} = $self->_column_to_storage($self->result_source, $key, $val)
+    if (
+      $self->has_column($key)
+        &&
+      exists $self->column_info($key)->{_filter_info}
+    ) {
+      $self->set_filtered_column($key, delete $attrs->{$key});
+
+      # FIXME update() reaches directly into the object-hash
+      # and we may *not* have a filtered value there - thus
+      # the void-ctx filter-trigger
+      $self->get_column($key) unless exists $self->{_column_data}{$key};
     }
   }
+
   return $self->next::method($attrs, @rest);
 }
 
-
 sub new {
   my ($class, $attrs, @rest) = @_;
-  my $source = delete $attrs->{-result_source}
+  my $source = $attrs->{-result_source}
     or $class->throw_exception('Sourceless rows are not supported with DBIx::Class::FilterColumn');
 
+  my $obj = $class->next::method($attrs, @rest);
   foreach my $key (keys %{$attrs||{}}) {
-    if ($class->has_column($key) &&
-          exists $class->column_info($key)->{_filter_info} ) {
-      $attrs->{$key} = $class->_column_to_storage($source, $key, delete $attrs->{$key})
+    if ($obj->has_column($key) &&
+          exists $obj->column_info($key)->{_filter_info} ) {
+      $obj->set_filtered_column($key, $attrs->{$key});
     }
   }
-  my $obj = $class->next::method($attrs, @rest);
+
   return $obj;
 }
 
 1;
 
-=head1 THE ONE TRUE WAY
+=head1 NAME
+
+DBIx::Class::FilterColumn - Automatically convert column data
 
- package My::Reusable::Filter;
+=head1 SYNOPSIS
+
+ # In your result classes
+ __PACKAGE__->filter_column( money => {
+     filter_to_storage => 'to_pennies',
+     filter_from_storage => 'from_pennies',
+ });
 
  sub to_pennies   { $_[1] * 100 }
+
  sub from_pennies { $_[1] / 100 }
 
  1;
 
- package My::Schema::Result::Account;
+=head1 DESCRIPTION
 
- use strict;
- use warnings;
+This component is meant to be a more powerful, but less DWIM-y,
+L<DBIx::Class::InflateColumn>.  One of the major issues with said component is
+that it B<only> works with references.  Generally speaking anything that can
+be done with L<DBIx::Class::InflateColumn> can be done with this component.
 
- use base 'DBIx::Class::Core';
+=head1 METHODS
 
- __PACKAGE->load_components('FilterColumn');
+=head2 filter_column
 
- __PACKAGE__->add_columns(
-   id => {
-     data_type => 'int',
-     is_auto_increment => 1,
-   },
-   total_money => {
-     data_type => 'int',
-   },
- );
+ __PACKAGE__->filter_column( colname => {
+     filter_from_storage => 'method',
+     filter_to_storage   => 'method',
+ })
 
- __PACKAGE__->set_primary_key('id');
+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<HashRef> with C<filter_from_storage> and C<filter_to_storage> 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.
 
- __PACKAGE__->filter_column(total_money => {
-   filter_to_storage   => 'to_pennies',
-   filter_from_storage => 'from_pennies',
- });
+=head2 get_filtered_column
 
- 1;
+ $obj->get_filtered_column('colname')
+
+Returns the filtered value of the column
+
+=head2 set_filtered_column
+
+ $obj->set_filtered_column(colname => 'new_value')
 
+Sets the filtered value of the column