take advantage of join_query_parts to clean up
[dbsrgits/SQL-Abstract.git] / lib / SQL / Abstract / Clauses.pm
CommitLineData
8f306bb1 1package SQL::Abstract::Clauses;
2
3use strict;
4use warnings;
740af2e0 5use if $] < '5.010', 'MRO::Compat';
8f306bb1 6use mro 'c3';
7use base 'SQL::Abstract';
8
d5f4b9d3 9BEGIN { *puke = \&SQL::Abstract::puke }
10
8f306bb1 11sub new {
12 shift->next::method(@_)->register_defaults
13}
14
15sub register_defaults {
16 my ($self) = @_;
17 $self->{clauses_of}{select} = [ qw(select from where order_by) ];
18 $self->{expand}{select} = sub { shift->_expand_statement(@_) };
6c39a2f7 19 $self->{render}{select} = sub { shift->_render_statement(@_) };
8cad5d13 20 $self->{expand_clause}{"select.$_"} = "_expand_select_clause_$_"
21 for @{$self->{clauses_of}{select}};
45a145cf 22 $self->{clauses_of}{update} = [ qw(target set where returning) ];
d5f4b9d3 23 $self->{expand}{update} = sub { shift->_expand_statement(@_) };
6c39a2f7 24 $self->{render}{update} = sub { shift->_render_statement(@_) };
4c0c4404 25 $self->{expand_clause}{"update.$_"} = "_expand_update_clause_$_"
26 for @{$self->{clauses_of}{update}};
45a145cf 27 $self->{expand_clause}{'update.update'} = '_expand_update_clause_target';
28 $self->{render_clause}{'update.target'} = sub {
1107714b 29 my ($self, undef, $target) = @_;
45a145cf 30 my ($sql, @bind) = $self->render_aqt($target);
31 ($self->_sqlcase('update ').$sql, @bind);
32 };
33 $self->{clauses_of}{delete} = [ qw(target where returning) ];
be12624c 34 $self->{expand}{delete} = sub { shift->_expand_statement(@_) };
6c39a2f7 35 $self->{render}{delete} = sub { shift->_render_statement(@_) };
bc637c4f 36 $self->{expand_clause}{"delete.$_"} = "_expand_delete_clause_$_"
37 for @{$self->{clauses_of}{delete}};
45a145cf 38 $self->{expand_clause}{"delete.from"} = '_expand_delete_clause_target';
39 $self->{render_clause}{'delete.target'} = sub {
1107714b 40 my ($self, undef, $from) = @_;
45a145cf 41 my ($sql, @bind) = $self->render_aqt($from);
42 ($self->_sqlcase('delete from ').$sql, @bind);
43 };
6a47389f 44 $self->{clauses_of}{insert} = [
bea59460 45 'target', 'fields', 'from', 'returning'
6a47389f 46 ];
5ed4a77e 47 $self->{expand}{insert} = sub { shift->_expand_statement(@_) };
6c39a2f7 48 $self->{render}{insert} = sub { shift->_render_statement(@_) };
45a145cf 49 $self->{expand_clause}{'insert.into'} = '_expand_insert_clause_target';
50 $self->{expand_clause}{'insert.target'} = '_expand_insert_clause_target';
73f1883a 51 $self->{expand_clause}{'insert.fields'} = sub {
52 return +{ -row => [
1107714b 53 shift->_expand_maybe_list_expr($_[2], -ident)
54 ] } if ref($_[2]) eq 'ARRAY';
55 return $_[2]; # should maybe still expand somewhat?
73f1883a 56 };
89bbac1d 57 $self->{expand_clause}{'insert.values'} = '_expand_insert_clause_values';
5ed4a77e 58 $self->{expand_clause}{'insert.returning'} = sub {
59 shift->_expand_maybe_list_expr(@_, -ident);
60 };
6a47389f 61 $self->{render_clause}{'insert.fields'} = sub {
1107714b 62 return $_[0]->render_aqt($_[2]);
6a47389f 63 };
45a145cf 64 $self->{render_clause}{'insert.target'} = sub {
1107714b 65 my ($self, undef, $from) = @_;
45a145cf 66 my ($sql, @bind) = $self->render_aqt($from);
67 ($self->_sqlcase('insert into ').$sql, @bind);
68 };
bea59460 69 $self->{render_clause}{'insert.from'} = sub {
1107714b 70 return $_[0]->render_aqt($_[2], 1);
6da32de8 71 };
434c40f1 72 $self->{expand}{values} = '_expand_values';
73 $self->{render}{values} = '_render_values';
f47b547b 74 $self->{expand}{exists} = sub {
75 $_[0]->_expand_op(undef, [ exists => $_[2] ]);
76 };
bfa2e351 77 $self->{render}{convert_where} = sub {
78 my $self = shift;
79 local $self->{convert_where} = $self->{convert};
80 $self->render_aqt($_[0]);
81 };
8f306bb1 82 return $self;
83}
84
8cad5d13 85sub _expand_select_clause_select {
1107714b 86 my ($self, undef, $select) = @_;
8cad5d13 87 +(select => $self->_expand_maybe_list_expr($select, -ident));
88}
89
90sub _expand_select_clause_from {
1107714b 91 my ($self, undef, $from) = @_;
8cad5d13 92 +(from => $self->_expand_maybe_list_expr($from, -ident));
93}
94
95sub _expand_select_clause_where {
1107714b 96 my ($self, undef, $where) = @_;
bfa2e351 97 my $exp = $self->expand_expr($where);
98 +(where => ($self->{convert} ? { -convert_where => $exp } : $exp));
8cad5d13 99}
100
101sub _expand_select_clause_order_by {
1107714b 102 my ($self, undef, $order_by) = @_;
8cad5d13 103 +(order_by => $self->_expand_order_by($order_by));
104}
105
45a145cf 106sub _expand_update_clause_target {
1107714b 107 my ($self, undef, $target) = @_;
0891ae97 108 +(target => $self->_expand_maybe_list_expr($target, -ident));
4c0c4404 109}
110
111sub _expand_update_clause_set {
1107714b 112 return $_[2] if ref($_[2]) eq 'HASH' and ($_[2]->{-op}||[''])->[0] eq ',';
113 +(set => $_[0]->_expand_update_set_values($_[1], $_[2]));
4c0c4404 114}
115
116sub _expand_update_clause_where {
1107714b 117 +(where => $_[0]->expand_expr($_[2]));
4c0c4404 118}
119
120sub _expand_update_clause_returning {
1107714b 121 +(returning => $_[0]->_expand_maybe_list_expr($_[2], -ident));
4c0c4404 122}
123
45a145cf 124sub _expand_delete_clause_target {
1107714b 125 +(target => $_[0]->_expand_maybe_list_expr($_[2], -ident));
bc637c4f 126}
127
1107714b 128sub _expand_delete_clause_where { +(where => $_[0]->expand_expr($_[2])); }
bc637c4f 129
130sub _expand_delete_clause_returning {
1107714b 131 +(returning => $_[0]->_expand_maybe_list_expr($_[2], -ident));
bc637c4f 132}
133
8f306bb1 134sub _expand_statement {
135 my ($self, $type, $args) = @_;
136 my $ec = $self->{expand_clause};
af407e9a 137 if ($args->{_}) {
138 $args = { %$args };
139 $args->{$type} = delete $args->{_}
140 }
25b45941 141 return +{ "-${type}" => +{
95894429 142 map {
8f306bb1 143 my $val = $args->{$_};
144 if (defined($val) and my $exp = $ec->{"${type}.$_"}) {
1107714b 145 if ((my (@exp) = $self->$exp($_ => $val)) == 1) {
95894429 146 ($_ => $exp[0])
147 } else {
148 @exp
149 }
8f306bb1 150 } else {
bea59460 151 ($_ => $self->expand_expr($val))
8f306bb1 152 }
95894429 153 } sort keys %$args
25b45941 154 } };
8f306bb1 155}
156
157sub _render_statement {
158 my ($self, $type, $args) = @_;
159 my @parts;
160 foreach my $clause (@{$self->{clauses_of}{$type}}) {
161 next unless my $clause_expr = $args->{$clause};
b9d32abc 162 my @part = do {
6a47389f 163 if (my $rdr = $self->{render_clause}{"${type}.${clause}"}) {
1107714b 164 $self->$rdr($clause, $clause_expr);
6a47389f 165 } else {
434c40f1 166 my ($clause_sql, @bind) = $self->render_aqt($clause_expr, 1);
6a47389f 167 my $sql = join ' ',
168 $self->_sqlcase(join ' ', split '_', $clause),
169 $clause_sql;
170 ($sql, @bind);
171 }
172 };
6a47389f 173 push @parts, \@part;
8f306bb1 174 }
59c7f80e 175 my ($sql, @bind) = $self->join_query_parts(' ', @parts);
434c40f1 176 return (
177 (our $Render_Top_Level ? $sql : '('.$sql.')'),
178 @bind
179 );
180}
181
182sub render_aqt {
183 my ($self, $aqt, $top_level) = @_;
184 local our $Render_Top_Level = $top_level;
185 return $self->next::method($aqt);
186}
187
188sub render_statement {
189 my ($self, $expr, $default_scalar_to) = @_;
190 my ($sql, @bind) = $self->render_aqt(
191 $self->expand_expr($expr, $default_scalar_to), 1
192 );
193 return (wantarray ? ($sql, @bind) : $sql);
8f306bb1 194}
195
b96fbdc0 196sub select {
197 my ($self, @args) = @_;
73f1883a 198
434c40f1 199 return $self->render_statement({ -select => $_[1] }) if ref($_[1]) eq 'HASH';
73f1883a 200
b96fbdc0 201 my %clauses;
202 @clauses{qw(from select where order_by)} = @args;
0c3c4c23 203
b96fbdc0 204 # This oddity is to literalify since historically SQLA doesn't quote
0c3c4c23 205 # a single identifier argument, so we convert it into a literal
206
91d37de5 207 $clauses{select} = { -literal => [ $clauses{select}||'*' ] }
208 unless ref($clauses{select});
209
434c40f1 210 return $self->render_statement({ -select => \%clauses });
b96fbdc0 211}
212
d5f4b9d3 213sub update {
214 my ($self, $table, $set, $where, $options) = @_;
73f1883a 215
434c40f1 216 return $self->render_statement({ -update => $_[1] }) if ref($_[1]) eq 'HASH';
73f1883a 217
d5f4b9d3 218 my %clauses;
45a145cf 219 @clauses{qw(target set where)} = ($table, $set, $where);
d5f4b9d3 220 puke "Unsupported data type specified to \$sql->update"
221 unless ref($clauses{set}) eq 'HASH';
222 @clauses{keys %$options} = values %$options;
434c40f1 223 return $self->render_statement({ -update => \%clauses });
d5f4b9d3 224}
225
be12624c 226sub delete {
227 my ($self, $table, $where, $options) = @_;
73f1883a 228
434c40f1 229 return $self->render_statement({ -delete => $_[1] }) if ref($_[1]) eq 'HASH';
73f1883a 230
45a145cf 231 my %clauses = (target => $table, where => $where, %{$options||{}});
434c40f1 232 return $self->render_statement({ -delete => \%clauses });
be12624c 233}
234
5ed4a77e 235sub insert {
236 my ($self, $table, $data, $options) = @_;
73f1883a 237
434c40f1 238 return $self->render_statement({ -insert => $_[1] }) if ref($_[1]) eq 'HASH';
73f1883a 239
45a145cf 240 my %clauses = (target => $table, values => $data, %{$options||{}});
434c40f1 241 return $self->render_statement({ -insert => \%clauses });
5ed4a77e 242}
243
45a145cf 244sub _expand_insert_clause_target {
1107714b 245 +(target => $_[0]->_expand_maybe_list_expr($_[2], -ident));
45a145cf 246}
247
89bbac1d 248sub _expand_insert_clause_values {
1107714b 249 my ($self, undef, $data) = @_;
6da32de8 250 if (ref($data) eq 'HASH' and (keys(%$data))[0] =~ /^-/) {
251 return $self->expand_expr($data);
252 }
e5d02bc7 253 return $data if ref($data) eq 'HASH' and $data->{-row};
89bbac1d 254 my ($f_aqt, $v_aqt) = $self->_expand_insert_values($data);
bea59460 255 return (from => { -values => $v_aqt }, ($f_aqt ? (fields => $f_aqt) : ()));
89bbac1d 256}
257
434c40f1 258sub _expand_values {
259 my ($self, undef, $values) = @_;
260 return { -values => [
261 map +(
262 ref($_) eq 'HASH'
263 ? $self->expand_expr($_)
264 : +{ -row => [ map $self->expand_expr($_), @$_ ] }
265 ), ref($values) eq 'ARRAY' ? @$values : $values
266 ] };
267}
268
269sub _render_values {
6c39a2f7 270 my ($self, undef, $values) = @_;
59c7f80e 271 my ($v_sql, @bind) = $self->join_query_parts(
434c40f1 272 ', ',
3e230b71 273 ref($values) eq 'ARRAY' ? @$values : $values
434c40f1 274 );
275 my $sql = $self->_sqlcase('values').' '.$v_sql;
276 return (
277 (our $Render_Top_Level ? $sql : '('.$sql.')'),
278 @bind
279 );
280}
281
8637f869 282sub _ext_rw {
283 my ($self, $name, $key, $value) = @_;
f7a20100 284 return $self->{$name}{$key} unless @_ > 3;
8637f869 285 $self->{$name}{$key} = $value;
286 return $self;
287}
288
52a5554b 289BEGIN {
290 foreach my $type (qw(
f7a20100 291 expand op_expand render op_render clause_expand clause_render
52a5554b 292 )) {
95ab9342 293 my $name = join '_', reverse split '_', $type;
71c1b4d5 294 my $singular = "${type}er";
95ab9342 295 eval qq{sub ${singular} { shift->_ext_rw($name => \@_) }; 1 }
296 or die "Method builder failed for ${singular}: $@";
297 eval qq{sub wrap_${singular} {
298 my (\$self, \$key, \$builder) = \@_;
299 my \$orig = \$self->_ext_rw('${name}', \$key);
300 \$self->_ext_rw(
301 '${name}', \$key,
302 \$builder->(\$orig, '${name}', \$key)
303 );
304 }; 1 } or die "Method builder failed for wrap_${singular}: $@";
71c1b4d5 305 eval qq{sub ${singular}s {
306 my (\$self, \@args) = \@_;
307 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
95ab9342 308 \$self->{${name}}{\$this_key} = \$this_value;
71c1b4d5 309 }
310 return \$self;
311 }; 1 } or die "Method builder failed for ${singular}s: $@";
95ab9342 312 eval qq{sub ${singular}_list { sort keys %{\$_[0]->{\$name}} }; 1; }
313 or die "Method builder failed for ${singular}_list: $@";
52a5554b 314 }
315}
8637f869 316
78bbc7c8 317sub statement_list { sort keys %{$_[0]->{clauses_of}} }
08a26ed6 318
8637f869 319sub clauses_of {
320 my ($self, $of, @clauses) = @_;
321 unless (@clauses) {
322 return @{$self->{clauses_of}{$of}||[]};
323 }
e6b86bee 324 if (ref($clauses[0]) eq 'CODE') {
325 @clauses = $self->${\($clauses[0])}(@{$self->{clauses_of}{$of}||[]});
326 }
8637f869 327 $self->{clauses_of}{$of} = \@clauses;
328 return $self;
329}
330
331sub clone {
332 my ($self) = @_;
333 bless(
334 {
335 (map +($_ => (
336 ref($self->{$_}) eq 'HASH'
337 ? { %{$self->{$_}} }
338 : $self->{$_}
339 )), keys %$self),
340 },
341 ref($self)
342 );
343}
344
8f306bb1 3451;