X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSetColumn.pm;h=1efdc35eef7ac94210a5957010011575afb44c71;hb=367eaf50970dd3fd223ce5e1f0337703f2a6c70e;hp=08795856dcd449949e67f6d83bb897bf299d92ce;hpb=bac358c9d99a75db2d2bab8f11102ed557f523b7;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/ResultSetColumn.pm b/lib/DBIx/Class/ResultSetColumn.pm index 0879585..1efdc35 100644 --- a/lib/DBIx/Class/ResultSetColumn.pm +++ b/lib/DBIx/Class/ResultSetColumn.pm @@ -4,12 +4,9 @@ use strict; use warnings; use base 'DBIx::Class'; - -use Carp::Clan qw/^DBIx::Class/; -use DBIx::Class::Exception; - -# not importing first() as it will clash with our own method -use List::Util (); +use DBIx::Class::Carp; +use DBIx::Class::_Util 'fail_on_internal_call'; +use namespace::clean; =head1 NAME @@ -48,6 +45,7 @@ sub new { my $orig_attrs = $rs->_resolved_attrs; my $alias = $rs->current_source_alias; + my $rsrc = $rs->result_source; # If $column can be found in the 'as' list of the parent resultset, use the # corresponding element of its 'select' list (to keep any custom column @@ -55,24 +53,31 @@ sub new { # (to create a new column definition on-the-fly). my $as_list = $orig_attrs->{as} || []; my $select_list = $orig_attrs->{select} || []; - my $as_index = List::Util::first { ($as_list->[$_] || "") eq $column } 0..$#$as_list; + my ($as_index) = grep { ($as_list->[$_] || "") eq $column } 0..$#$as_list; my $select = defined $as_index ? $select_list->[$as_index] : $column; + my $colmap; + for ($rsrc->columns, $column) { + if ($_ =~ /^ \Q$alias\E \. ([^\.]+) $ /x) { + $colmap->{$_} = $1; + } + elsif ($_ !~ /\./) { + $colmap->{"$alias.$_"} = $_; + $colmap->{$_} = $_; + } + } + my $new_parent_rs; # analyze the order_by, and see if it is done over a function/nonexistentcolumn # if this is the case we will need to wrap a subquery since the result of RSC # *must* be a single column select - my %collist = map - { $_ => 1, ($_ =~ /\./) ? () : ( "$alias.$_" => 1 ) } - ($rs->result_source->columns, $column) - ; if ( scalar grep - { ! $collist{$_->[0]} } - ( $rs->result_source->schema->storage->_extract_order_criteria ($orig_attrs->{order_by} ) ) + { ! exists $colmap->{$_->[0]} } + ( $rsrc->schema->storage->_extract_order_criteria ($orig_attrs->{order_by} ) ) ) { # nuke the prefetch before collapsing to sql - my $subq_rs = $rs->search; + my $subq_rs = $rs->search_rs; $subq_rs->{attrs}{join} = $subq_rs->_merge_joinpref_attr( $subq_rs->{attrs}{join}, delete $subq_rs->{attrs}{prefetch} ); $new_parent_rs = $subq_rs->as_subselect_rs; } @@ -88,26 +93,13 @@ sub new { # {collapse} would mean a has_many join was injected, which in turn means # we need to group *IF WE CAN* (only if the column in question is unique) - if (!$orig_attrs->{group_by} && keys %{$orig_attrs->{collapse}}) { - - # scan for a constraint that would contain our column only - that'd be proof - # enough it is unique - my $constraints = { $rs->result_source->unique_constraints }; - for my $constraint_columns ( values %$constraints ) { - - next unless @$constraint_columns == 1; + if (!$orig_attrs->{group_by} && $orig_attrs->{collapse}) { - my $col = $constraint_columns->[0]; - my $fqcol = join ('.', $new_attrs->{alias}, $col); - - if ($col eq $select or $fqcol eq $select) { - $new_attrs->{group_by} = [ $select ]; - delete $new_attrs->{distinct}; # it is ignored when group_by is present - last; - } + if ($colmap->{$select} and $rsrc->_identifying_column_set([$colmap->{$select}])) { + $new_attrs->{group_by} = [ $select ]; + delete @{$new_attrs}{qw(distinct _grouped_by_distinct)}; # it is ignored when group_by is present } - - if (!$new_attrs->{group_by}) { + else { carp ( "Attempting to retrieve non-unique column '$column' on a resultset containing " . 'one-to-many joins will return duplicate results.' @@ -115,8 +107,11 @@ sub new { } } - my $new = bless { _select => $select, _as => $column, _parent_resultset => $new_parent_rs }, $class; - return $new; + return bless { + _select => $select, + _as => $column, + _parent_resultset => $new_parent_rs + }, $class; } =head2 as_query @@ -125,7 +120,7 @@ sub new { =item Arguments: none -=item Return Value: \[ $sql, @bind ] +=item Return Value: \[ $sql, L<@bind_values|DBIx::Class::ResultSet/DBIC BIND VALUES> ] =back @@ -150,18 +145,16 @@ sub as_query { return shift->_resultset->as_query(@_) } Returns the next value of the column in the resultset (or C if there is none). -Much like L but just returning the +Much like L but just returning the one value. =cut sub next { - my $self = shift; + #my $self = shift; # using cursor so we don't inflate anything - my ($row) = $self->_resultset->cursor->next; - - return $row; + ($_[0]->_resultset->cursor->next)[0]; } =head2 all @@ -178,15 +171,15 @@ Returns all values of the column in the resultset (or C if there are none). Much like L but returns values rather -than row objects. +than result objects. =cut sub all { - my $self = shift; + #my $self = shift; # using cursor so we don't inflate anything - return map { $_->[0] } $self->_resultset->cursor->all; + map { $_->[0] } $_[0]->_resultset->cursor->all; } =head2 reset @@ -207,9 +200,10 @@ Much like L. =cut sub reset { - my $self = shift; - $self->_resultset->cursor->reset; - return $self; + #my $self = shift; + + $_[0]->_resultset->reset; + $_[0]; } =head2 first @@ -229,14 +223,13 @@ Much like L but just returning the one value. =cut -sub first { - my $self = shift; +sub first :DBIC_method_is_indirect_sugar { + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call; # using cursor so we don't inflate anything - $self->_resultset->cursor->reset; - my ($row) = $self->_resultset->cursor->next; - - return $row; + my $cursor = $_[0]->_resultset->cursor; + $cursor->reset; + ($cursor->next)[0]; } =head2 single @@ -256,14 +249,14 @@ is issued before discarding the cursor. =cut sub single { - my $self = shift; + #my $self = shift; - my $attrs = $self->_resultset->_resolved_attrs; - my ($row) = $self->_resultset->result_source->storage->select_single( - $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs - ); + my $rs = $_[0]->_resultset; - return $row; + my $attrs = $rs->_resolved_attrs; + ($rs->result_source->schema->storage->select_single( + $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs + ))[0]; } =head2 min @@ -283,8 +276,9 @@ resultset (or C if there are none). =cut -sub min { - return shift->func('MIN'); +sub min :DBIC_method_is_indirect_sugar { + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call; + $_[0]->func('MIN'); } =head2 min_rs @@ -293,7 +287,7 @@ sub min { =item Arguments: none -=item Return Value: $resultset +=item Return Value: L<$resultset|DBIx::Class::ResultSet> =back @@ -303,7 +297,10 @@ Wrapper for ->func_rs for function MIN(). =cut -sub min_rs { return shift->func_rs('MIN') } +sub min_rs :DBIC_method_is_indirect_sugar { + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call; + $_[0]->func_rs('MIN') +} =head2 max @@ -322,8 +319,9 @@ resultset (or C if there are none). =cut -sub max { - return shift->func('MAX'); +sub max :DBIC_method_is_indirect_sugar { + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call; + $_[0]->func('MAX'); } =head2 max_rs @@ -332,7 +330,7 @@ sub max { =item Arguments: none -=item Return Value: $resultset +=item Return Value: L<$resultset|DBIx::Class::ResultSet> =back @@ -342,7 +340,10 @@ Wrapper for ->func_rs for function MAX(). =cut -sub max_rs { return shift->func_rs('MAX') } +sub max_rs :DBIC_method_is_indirect_sugar { + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call; + $_[0]->func_rs('MAX') +} =head2 sum @@ -361,8 +362,9 @@ the resultset. Use on varchar-like columns at your own risk. =cut -sub sum { - return shift->func('SUM'); +sub sum :DBIC_method_is_indirect_sugar { + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call; + $_[0]->func('SUM'); } =head2 sum_rs @@ -371,7 +373,7 @@ sub sum { =item Arguments: none -=item Return Value: $resultset +=item Return Value: L<$resultset|DBIx::Class::ResultSet> =back @@ -381,7 +383,10 @@ Wrapper for ->func_rs for function SUM(). =cut -sub sum_rs { return shift->func_rs('SUM') } +sub sum_rs :DBIC_method_is_indirect_sugar { + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call; + $_[0]->func_rs('SUM') +} =head2 func @@ -403,15 +408,16 @@ value. Produces the following SQL: =cut -sub func { - my ($self,$function) = @_; - my $cursor = $self->func_rs($function)->cursor; +sub func :DBIC_method_is_indirect_sugar{ + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call; - if( wantarray ) { - return map { $_->[ 0 ] } $cursor->all; - } + #my ($self,$function) = @_; + my $cursor = $_[0]->func_rs($_[1])->cursor; - return ( $cursor->next )[ 0 ]; + wantarray + ? map { $_->[ 0 ] } $cursor->all + : ( $cursor->next )[ 0 ] + ; } =head2 func_rs @@ -420,7 +426,7 @@ sub func { =item Arguments: $function -=item Return Value: $resultset +=item Return Value: L<$resultset|DBIx::Class::ResultSet> =back @@ -430,22 +436,38 @@ Creates the resultset that C uses to run its query. sub func_rs { my ($self,$function) = @_; - return $self->{_parent_resultset}->search( - undef, { - select => {$function => $self->{_select}}, - as => [$self->{_as}], - }, + + my $rs = $self->{_parent_resultset}; + my $select = $self->{_select}; + + # wrap a grouped rs + if ($rs->_resolved_attrs->{group_by}) { + $select = $self->{_as}; + $rs = $rs->as_subselect_rs; + } + + # FIXME - remove at some point in the future (2018-ish) + wantarray + and + carp_unique( + 'Starting with DBIC@0.082900 func_rs() always returns a ResultSet ' + . 'instance regardless of calling context. Please force scalar() context to ' + . 'silence this warning' ); + + $rs->search_rs( undef, { + columns => { $self->{_as} => { $function => $select } } + } ); } =head2 throw_exception See L for details. -=cut +=cut sub throw_exception { - my $self=shift; + my $self = shift; if (ref $self && $self->{_parent_resultset}) { $self->{_parent_resultset}->throw_exception(@_); @@ -469,24 +491,47 @@ sub throw_exception { sub _resultset { my $self = shift; - return $self->{_resultset} ||= $self->{_parent_resultset}->search(undef, - { - select => [$self->{_select}], - as => [$self->{_as}] + return $self->{_resultset} ||= do { + + my $select = $self->{_select}; + + if ($self->{_parent_resultset}{attrs}{distinct}) { + my $alias = $self->{_parent_resultset}->current_source_alias; + my $rsrc = $self->{_parent_resultset}->result_source; + my %cols = map { $_ => 1, "$alias.$_" => 1 } $rsrc->columns; + + unless( $cols{$select} ) { + carp_unique( + 'Use of distinct => 1 while selecting anything other than a column ' + . 'declared on the primary ResultSource is deprecated (you selected ' + . "'$self->{_as}') - please supply an explicit group_by instead" + ); + + # collapse the selector to a literal so that it survives the distinct parse + # if it turns out to be an aggregate - at least the user will get a proper exception + # instead of silent drop of the group_by altogether + $select = \[ $rsrc->schema->storage->sql_maker->_recurse_fields($select) ]; + } } - ); + + $self->{_parent_resultset}->search_rs(undef, { + columns => { $self->{_as} => $select } + }); + }; } -1; +=head1 FURTHER QUESTIONS? -=head1 AUTHORS +Check the list of L. -Luke Saunders +=head1 COPYRIGHT AND LICENSE -Jess Robinson +This module is free software L +by the L. You can +redistribute it and/or modify it under the same terms as the +L. -=head1 LICENSE +=cut -You may distribute this code under the same terms as Perl itself. +1; -=cut