Commit | Line | Data |
996be9ee |
1 | package DBIx::Class::Schema::Loader::Base; |
2 | |
3 | use strict; |
4 | use warnings; |
65e705c3 |
5 | use base qw/Class::Accessor::Grouped Class::C3::Componentised/; |
942bd5e0 |
6 | use mro 'c3'; |
fa994d3c |
7 | use Carp::Clan qw/^DBIx::Class/; |
996be9ee |
8 | use DBIx::Class::Schema::Loader::RelBuilder; |
9 | use Data::Dump qw/ dump /; |
10 | use POSIX qw//; |
dd03ee1a |
11 | use File::Spec qw//; |
419a2eeb |
12 | use Cwd qw//; |
7cab3ab7 |
13 | use Digest::MD5 qw//; |
22270947 |
14 | use Lingua::EN::Inflect::Number qw//; |
ecf930e6 |
15 | use Lingua::EN::Inflect::Phrase qw//; |
af31090c |
16 | use File::Temp qw//; |
17 | use Class::Unload; |
8048320c |
18 | use Class::Inspector (); |
f170d55b |
19 | use Scalar::Util 'looks_like_number'; |
b0d2b300 |
20 | use File::Slurp 'slurp'; |
c38ec663 |
21 | use DBIx::Class::Schema::Loader::Utils qw/split_name dumper_squashed eval_without_redefine_warnings/; |
ef8e9c69 |
22 | use DBIx::Class::Schema::Loader::Optional::Dependencies (); |
906fa216 |
23 | use Try::Tiny; |
ef8e9c69 |
24 | use DBIx::Class (); |
2b74a06b |
25 | use namespace::clean; |
996be9ee |
26 | |
6b1d4f76 |
27 | our $VERSION = '0.07001'; |
32f784fc |
28 | |
3d95f9ff |
29 | __PACKAGE__->mk_group_ro_accessors('simple', qw/ |
996be9ee |
30 | schema |
31 | schema_class |
32 | |
33 | exclude |
34 | constraint |
35 | additional_classes |
36 | additional_base_classes |
37 | left_base_classes |
38 | components |
39 | resultset_components |
59cfa251 |
40 | skip_relationships |
0ca61324 |
41 | skip_load_external |
996be9ee |
42 | moniker_map |
b639d969 |
43 | custom_column_info |
996be9ee |
44 | inflect_singular |
45 | inflect_plural |
46 | debug |
47 | dump_directory |
d65cda9e |
48 | dump_overwrite |
28b4691d |
49 | really_erase_my_files |
f44ecc2f |
50 | resultset_namespace |
51 | default_resultset_class |
9c9c2f2b |
52 | schema_base_class |
53 | result_base_class |
dcaf302a |
54 | use_moose |
8de81918 |
55 | overwrite_modifications |
996be9ee |
56 | |
c8c27020 |
57 | relationship_attrs |
58 | |
996be9ee |
59 | db_schema |
60 | _tables |
61 | classes |
f53dcdf0 |
62 | _upgrading_classes |
996be9ee |
63 | monikers |
106a976a |
64 | dynamic |
a8d229ff |
65 | naming |
42e785fa |
66 | datetime_timezone |
67 | datetime_locale |
73099af4 |
68 | config_file |
71a6e88a |
69 | loader_class |
69219349 |
70 | qualify_objects |
65e705c3 |
71 | /); |
72 | |
996be9ee |
73 | |
3d95f9ff |
74 | __PACKAGE__->mk_group_accessors('simple', qw/ |
01012543 |
75 | version_to_dump |
1c95b304 |
76 | schema_version_to_dump |
f53dcdf0 |
77 | _upgrading_from |
f22644d7 |
78 | _upgrading_from_load_classes |
a4b94090 |
79 | _downgrading_to_load_classes |
540a8149 |
80 | _rewriting_result_namespace |
f22644d7 |
81 | use_namespaces |
540a8149 |
82 | result_namespace |
492dce8d |
83 | generate_pod |
43b982ea |
84 | pod_comment_mode |
85 | pod_comment_spillover_length |
bc1cb85e |
86 | preserve_case |
01012543 |
87 | /); |
88 | |
996be9ee |
89 | =head1 NAME |
90 | |
91 | DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation. |
92 | |
93 | =head1 SYNOPSIS |
94 | |
95 | See L<DBIx::Class::Schema::Loader> |
96 | |
97 | =head1 DESCRIPTION |
98 | |
99 | This is the base class for the storage-specific C<DBIx::Class::Schema::*> |
100 | classes, and implements the common functionality between them. |
101 | |
102 | =head1 CONSTRUCTOR OPTIONS |
103 | |
104 | These constructor options are the base options for |
29ddb54c |
105 | L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are: |
3953cbee |
106 | |
59cfa251 |
107 | =head2 skip_relationships |
996be9ee |
108 | |
59cfa251 |
109 | Skip setting up relationships. The default is to attempt the loading |
110 | of relationships. |
996be9ee |
111 | |
0ca61324 |
112 | =head2 skip_load_external |
113 | |
114 | Skip loading of other classes in @INC. The default is to merge all other classes |
115 | with the same name found in @INC into the schema file we are creating. |
116 | |
9a95164d |
117 | =head2 naming |
118 | |
ecf930e6 |
119 | Static schemas (ones dumped to disk) will, by default, use the new-style |
9a95164d |
120 | relationship names and singularized Results, unless you're overwriting an |
ecf930e6 |
121 | existing dump made by an older version of L<DBIx::Class::Schema::Loader>, in |
122 | which case the backward compatible RelBuilder will be activated, and the |
123 | appropriate monikerization used. |
9a95164d |
124 | |
125 | Specifying |
126 | |
ecf930e6 |
127 | naming => 'current' |
9a95164d |
128 | |
129 | will disable the backward-compatible RelBuilder and use |
130 | the new-style relationship names along with singularized Results, even when |
131 | overwriting a dump made with an earlier version. |
132 | |
133 | The option also takes a hashref: |
134 | |
2a1ff2ee |
135 | naming => { relationships => 'v7', monikers => 'v7' } |
a8d229ff |
136 | |
137 | The keys are: |
138 | |
139 | =over 4 |
140 | |
141 | =item relationships |
142 | |
143 | How to name relationship accessors. |
144 | |
145 | =item monikers |
146 | |
147 | How to name Result classes. |
148 | |
f3a657ef |
149 | =item column_accessors |
150 | |
151 | How to name column accessors in Result classes. |
152 | |
a8d229ff |
153 | =back |
9a95164d |
154 | |
155 | The values can be: |
156 | |
157 | =over 4 |
158 | |
159 | =item current |
160 | |
ecf930e6 |
161 | Latest style, whatever that happens to be. |
162 | |
163 | =item v4 |
164 | |
165 | Unsingularlized monikers, C<has_many> only relationships with no _id stripping. |
9a95164d |
166 | |
167 | =item v5 |
168 | |
ecf930e6 |
169 | Monikers singularized as whole words, C<might_have> relationships for FKs on |
170 | C<UNIQUE> constraints, C<_id> stripping for belongs_to relationships. |
9a95164d |
171 | |
ecf930e6 |
172 | Some of the C<_id> stripping edge cases in C<0.05003> have been reverted for |
173 | the v5 RelBuilder. |
174 | |
175 | =item v6 |
9a95164d |
176 | |
19b7d71c |
177 | All monikers and relationships are inflected using |
178 | L<Lingua::EN::Inflect::Phrase>, and there is more aggressive C<_id> stripping |
179 | from relationship names. |
ecf930e6 |
180 | |
181 | In general, there is very little difference between v5 and v6 schemas. |
9a95164d |
182 | |
9990e58f |
183 | =item v7 |
184 | |
185 | This mode is identical to C<v6> mode, except that monikerization of CamelCase |
186 | table names is also done correctly. |
187 | |
0c1d5b47 |
188 | CamelCase column names in case-preserving mode will also be handled correctly |
189 | for relationship name inflection. See L</preserve_case>. |
19b7d71c |
190 | |
f3a657ef |
191 | In this mode, CamelCase L</column_accessors> are normalized based on case |
192 | transition instead of just being lowercased, so C<FooId> becomes C<foo_id>. |
193 | |
19b7d71c |
194 | If you don't have any CamelCase table or column names, you can upgrade without |
195 | breaking any of your code. |
9990e58f |
196 | |
9a95164d |
197 | =back |
198 | |
199 | Dynamic schemas will always default to the 0.04XXX relationship names and won't |
200 | singularize Results for backward compatibility, to activate the new RelBuilder |
201 | and singularization put this in your C<Schema.pm> file: |
202 | |
203 | __PACKAGE__->naming('current'); |
204 | |
c9cf9b4d |
205 | Or if you prefer to use 0.07XXX features but insure that nothing breaks in the |
9a95164d |
206 | next major version upgrade: |
207 | |
c9cf9b4d |
208 | __PACKAGE__->naming('v7'); |
9a95164d |
209 | |
492dce8d |
210 | =head2 generate_pod |
211 | |
212 | By default POD will be generated for columns and relationships, using database |
7f2de014 |
213 | metadata for the text if available and supported. |
214 | |
215 | Reading database metadata (e.g. C<COMMENT ON TABLE some_table ...>) is only |
216 | supported for Postgres right now. |
492dce8d |
217 | |
218 | Set this to C<0> to turn off all POD generation. |
219 | |
43b982ea |
220 | =head2 pod_comment_mode |
221 | |
f7976fea |
222 | Controls where table comments appear in the generated POD. Smaller table |
223 | comments are appended to the C<NAME> section of the documentation, and larger |
224 | ones are inserted into C<DESCRIPTION> instead. You can force a C<DESCRIPTION> |
225 | section to be generated with the comment always, only use C<NAME>, or choose |
226 | the length threshold at which the comment is forced into the description. |
43b982ea |
227 | |
34896b5e |
228 | =over 4 |
229 | |
230 | =item name |
231 | |
232 | Use C<NAME> section only. |
233 | |
234 | =item description |
235 | |
236 | Force C<DESCRIPTION> always. |
237 | |
238 | =item auto |
239 | |
240 | Use C<DESCRIPTION> if length > L</pod_comment_spillover_length>, this is the |
241 | default. |
242 | |
243 | =back |
43b982ea |
244 | |
245 | =head2 pod_comment_spillover_length |
246 | |
247 | When pod_comment_mode is set to C<auto>, this is the length of the comment at |
248 | which it will be forced into a separate description section. |
249 | |
250 | The default is C<60> |
251 | |
c8c27020 |
252 | =head2 relationship_attrs |
253 | |
254 | Hashref of attributes to pass to each generated relationship, listed |
255 | by type. Also supports relationship type 'all', containing options to |
256 | pass to all generated relationships. Attributes set for more specific |
257 | relationship types override those set in 'all'. |
258 | |
259 | For example: |
260 | |
261 | relationship_attrs => { |
aa0867ee |
262 | belongs_to => { is_deferrable => 0 }, |
c8c27020 |
263 | }, |
264 | |
aa0867ee |
265 | use this to turn off DEFERRABLE on your foreign key constraints. |
c8c27020 |
266 | |
996be9ee |
267 | =head2 debug |
268 | |
269 | If set to true, each constructive L<DBIx::Class> statement the loader |
270 | decides to execute will be C<warn>-ed before execution. |
271 | |
d65cda9e |
272 | =head2 db_schema |
273 | |
274 | Set the name of the schema to load (schema in the sense that your database |
275 | vendor means it). Does not currently support loading more than one schema |
276 | name. |
277 | |
996be9ee |
278 | =head2 constraint |
279 | |
280 | Only load tables matching regex. Best specified as a qr// regex. |
281 | |
282 | =head2 exclude |
283 | |
284 | Exclude tables matching regex. Best specified as a qr// regex. |
285 | |
286 | =head2 moniker_map |
287 | |
8f9d7ce5 |
288 | Overrides the default table name to moniker translation. Can be either |
289 | a hashref of table keys and moniker values, or a coderef for a translator |
996be9ee |
290 | function taking a single scalar table name argument and returning |
291 | a scalar moniker. If the hash entry does not exist, or the function |
292 | returns a false value, the code falls back to default behavior |
293 | for that table name. |
294 | |
9990e58f |
295 | The default behavior is to split on case transition and non-alphanumeric |
296 | boundaries, singularize the resulting phrase, then join the titlecased words |
297 | together. Examples: |
996be9ee |
298 | |
9990e58f |
299 | Table Name | Moniker Name |
300 | --------------------------------- |
301 | luser | Luser |
302 | luser_group | LuserGroup |
303 | luser-opts | LuserOpt |
304 | stations_visited | StationVisited |
305 | routeChange | RouteChange |
996be9ee |
306 | |
307 | =head2 inflect_plural |
308 | |
309 | Just like L</moniker_map> above (can be hash/code-ref, falls back to default |
310 | if hash key does not exist or coderef returns false), but acts as a map |
311 | for pluralizing relationship names. The default behavior is to utilize |
312 | L<Lingua::EN::Inflect::Number/to_PL>. |
313 | |
314 | =head2 inflect_singular |
315 | |
316 | As L</inflect_plural> above, but for singularizing relationship names. |
317 | Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>. |
318 | |
9c9c2f2b |
319 | =head2 schema_base_class |
320 | |
321 | Base class for your schema classes. Defaults to 'DBIx::Class::Schema'. |
322 | |
323 | =head2 result_base_class |
324 | |
2229729e |
325 | Base class for your table classes (aka result classes). Defaults to |
326 | 'DBIx::Class::Core'. |
9c9c2f2b |
327 | |
996be9ee |
328 | =head2 additional_base_classes |
329 | |
330 | List of additional base classes all of your table classes will use. |
331 | |
332 | =head2 left_base_classes |
333 | |
334 | List of additional base classes all of your table classes will use |
335 | that need to be leftmost. |
336 | |
337 | =head2 additional_classes |
338 | |
339 | List of additional classes which all of your table classes will use. |
340 | |
341 | =head2 components |
342 | |
343 | List of additional components to be loaded into all of your table |
eccc52fe |
344 | classes. A good example would be |
345 | L<InflateColumn::DateTime|DBIx::Class::InflateColumn::DateTime> |
996be9ee |
346 | |
347 | =head2 resultset_components |
348 | |
8f9d7ce5 |
349 | List of additional ResultSet components to be loaded into your table |
996be9ee |
350 | classes. A good example would be C<AlwaysRS>. Component |
351 | C<ResultSetManager> will be automatically added to the above |
352 | C<components> list if this option is set. |
353 | |
f44ecc2f |
354 | =head2 use_namespaces |
355 | |
f22644d7 |
356 | This is now the default, to go back to L<DBIx::Class::Schema/load_classes> pass |
357 | a C<0>. |
358 | |
f44ecc2f |
359 | Generate result class names suitable for |
360 | L<DBIx::Class::Schema/load_namespaces> and call that instead of |
361 | L<DBIx::Class::Schema/load_classes>. When using this option you can also |
362 | specify any of the options for C<load_namespaces> (i.e. C<result_namespace>, |
363 | C<resultset_namespace>, C<default_resultset_class>), and they will be added |
364 | to the call (and the generated result class names adjusted appropriately). |
365 | |
996be9ee |
366 | =head2 dump_directory |
367 | |
368 | This option is designed to be a tool to help you transition from this |
369 | loader to a manually-defined schema when you decide it's time to do so. |
370 | |
371 | The value of this option is a perl libdir pathname. Within |
372 | that directory this module will create a baseline manual |
373 | L<DBIx::Class::Schema> module set, based on what it creates at runtime |
374 | in memory. |
375 | |
376 | The created schema class will have the same classname as the one on |
377 | which you are setting this option (and the ResultSource classes will be |
7cab3ab7 |
378 | based on this name as well). |
996be9ee |
379 | |
8f9d7ce5 |
380 | Normally you wouldn't hard-code this setting in your schema class, as it |
996be9ee |
381 | is meant for one-time manual usage. |
382 | |
383 | See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the |
384 | recommended way to access this functionality. |
385 | |
d65cda9e |
386 | =head2 dump_overwrite |
387 | |
28b4691d |
388 | Deprecated. See L</really_erase_my_files> below, which does *not* mean |
389 | the same thing as the old C<dump_overwrite> setting from previous releases. |
390 | |
391 | =head2 really_erase_my_files |
392 | |
7cab3ab7 |
393 | Default false. If true, Loader will unconditionally delete any existing |
394 | files before creating the new ones from scratch when dumping a schema to disk. |
395 | |
396 | The default behavior is instead to only replace the top portion of the |
397 | file, up to and including the final stanza which contains |
398 | C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!> |
399 | leaving any customizations you placed after that as they were. |
400 | |
28b4691d |
401 | When C<really_erase_my_files> is not set, if the output file already exists, |
7cab3ab7 |
402 | but the aforementioned final stanza is not found, or the checksum |
403 | contained there does not match the generated contents, Loader will |
404 | croak and not touch the file. |
d65cda9e |
405 | |
28b4691d |
406 | You should really be using version control on your schema classes (and all |
407 | of the rest of your code for that matter). Don't blame me if a bug in this |
408 | code wipes something out when it shouldn't have, you've been warned. |
409 | |
639a1367 |
410 | =head2 overwrite_modifications |
411 | |
412 | Default false. If false, when updating existing files, Loader will |
413 | refuse to modify any Loader-generated code that has been modified |
414 | since its last run (as determined by the checksum Loader put in its |
415 | comment lines). |
416 | |
417 | If true, Loader will discard any manual modifications that have been |
418 | made to Loader-generated code. |
419 | |
420 | Again, you should be using version control on your schema classes. Be |
421 | careful with this option. |
422 | |
3a368709 |
423 | =head2 custom_column_info |
424 | |
d67d058e |
425 | Hook for adding extra attributes to the |
426 | L<column_info|DBIx::Class::ResultSource/column_info> for a column. |
427 | |
428 | Must be a coderef that returns a hashref with the extra attributes. |
429 | |
430 | Receives the table name, column name and column_info. |
431 | |
432 | For example: |
433 | |
434 | custom_column_info => sub { |
435 | my ($table_name, $column_name, $column_info) = @_; |
436 | |
437 | if ($column_name eq 'dog' && $column_info->{default_value} eq 'snoopy') { |
438 | return { is_snoopy => 1 }; |
439 | } |
440 | }, |
3a368709 |
441 | |
d67d058e |
442 | This attribute can also be used to set C<inflate_datetime> on a non-datetime |
443 | column so it also receives the L</datetime_timezone> and/or L</datetime_locale>. |
3a368709 |
444 | |
42e785fa |
445 | =head2 datetime_timezone |
446 | |
d67d058e |
447 | Sets the timezone attribute for L<DBIx::Class::InflateColumn::DateTime> for all |
448 | columns with the DATE/DATETIME/TIMESTAMP data_types. |
42e785fa |
449 | |
450 | =head2 datetime_locale |
451 | |
d67d058e |
452 | Sets the locale attribute for L<DBIx::Class::InflateColumn::DateTime> for all |
453 | columns with the DATE/DATETIME/TIMESTAMP data_types. |
42e785fa |
454 | |
7ffafa37 |
455 | =head2 config_file |
73099af4 |
456 | |
457 | File in Perl format, which should return a HASH reference, from which to read |
458 | loader options. |
459 | |
7ffafa37 |
460 | =head2 preserve_case |
bc1cb85e |
461 | |
462 | Usually column names are lowercased, to make them easier to work with in |
463 | L<DBIx::Class>. This option lets you turn this behavior off, if the driver |
464 | supports it. |
465 | |
466 | Drivers for case sensitive databases like Sybase ASE or MSSQL with a |
467 | case-sensitive collation will turn this option on unconditionally. |
468 | |
469 | Currently the drivers for SQLite, mysql, MSSQL and Firebird/InterBase support |
470 | setting this option. |
471 | |
7ffafa37 |
472 | =head2 qualify_objects |
69219349 |
473 | |
474 | Set to true to prepend the L</db_schema> to table names for C<< |
475 | __PACKAGE__->table >> calls, and to some other things like Oracle sequences. |
476 | |
7d0ea6b9 |
477 | =head2 use_moose |
478 | |
479 | Creates Schema and Result classes that use L<Moose>, L<MooseX::NonMoose> and |
1336ac63 |
480 | L<namespace::autoclean>. The default content after the md5 sum also makes the |
481 | classes immutable. |
7d0ea6b9 |
482 | |
483 | It is safe to upgrade your existing Schema to this option. |
484 | |
996be9ee |
485 | =head1 METHODS |
486 | |
487 | None of these methods are intended for direct invocation by regular |
d67d058e |
488 | users of L<DBIx::Class::Schema::Loader>. Some are proxied via |
489 | L<DBIx::Class::Schema::Loader>. |
996be9ee |
490 | |
491 | =cut |
492 | |
9990e58f |
493 | my $CURRENT_V = 'v7'; |
8048320c |
494 | |
c5df7397 |
495 | my @CLASS_ARGS = qw( |
8048320c |
496 | schema_base_class result_base_class additional_base_classes |
497 | left_base_classes additional_classes components resultset_components |
498 | ); |
66afce69 |
499 | |
996be9ee |
500 | # ensure that a peice of object data is a valid arrayref, creating |
501 | # an empty one or encapsulating whatever's there. |
502 | sub _ensure_arrayref { |
503 | my $self = shift; |
504 | |
505 | foreach (@_) { |
506 | $self->{$_} ||= []; |
507 | $self->{$_} = [ $self->{$_} ] |
508 | unless ref $self->{$_} eq 'ARRAY'; |
509 | } |
510 | } |
511 | |
512 | =head2 new |
513 | |
514 | Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally |
515 | by L<DBIx::Class::Schema::Loader>. |
516 | |
517 | =cut |
518 | |
519 | sub new { |
520 | my ( $class, %args ) = @_; |
521 | |
522 | my $self = { %args }; |
523 | |
8de81918 |
524 | # don't lose undef options |
525 | for (values %$self) { |
526 | $_ = 0 unless defined $_; |
527 | } |
528 | |
996be9ee |
529 | bless $self => $class; |
530 | |
73099af4 |
531 | if (my $config_file = $self->config_file) { |
532 | my $config_opts = do $config_file; |
533 | |
534 | croak "Error reading config from $config_file: $@" if $@; |
535 | |
536 | croak "Config file $config_file must be a hashref" unless ref($config_opts) eq 'HASH'; |
537 | |
538 | while (my ($k, $v) = each %$config_opts) { |
539 | $self->{$k} = $v unless exists $self->{$k}; |
540 | } |
541 | } |
542 | |
996be9ee |
543 | $self->_ensure_arrayref(qw/additional_classes |
544 | additional_base_classes |
545 | left_base_classes |
546 | components |
547 | resultset_components |
548 | /); |
549 | |
8048320c |
550 | $self->_validate_class_args; |
551 | |
c9cf9b4d |
552 | if ($self->use_moose) { |
ef8e9c69 |
553 | if (not DBIx::Class::Schema::Loader::Optional::Dependencies->req_ok_for('use_moose')) { |
53e721bc |
554 | die sprintf "You must install the following CPAN modules to enable the use_moose option: %s.\n", |
ef8e9c69 |
555 | DBIx::Class::Schema::Loader::Optional::Dependencies->req_missing_for('use_moose'); |
c9cf9b4d |
556 | } |
557 | } |
558 | |
996be9ee |
559 | push(@{$self->{components}}, 'ResultSetManager') |
560 | if @{$self->{resultset_components}}; |
561 | |
562 | $self->{monikers} = {}; |
563 | $self->{classes} = {}; |
f53dcdf0 |
564 | $self->{_upgrading_classes} = {}; |
996be9ee |
565 | |
996be9ee |
566 | $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} ); |
567 | $self->{schema} ||= $self->{schema_class}; |
568 | |
28b4691d |
569 | croak "dump_overwrite is deprecated. Please read the" |
570 | . " DBIx::Class::Schema::Loader::Base documentation" |
571 | if $self->{dump_overwrite}; |
572 | |
af31090c |
573 | $self->{dynamic} = ! $self->{dump_directory}; |
79193756 |
574 | $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX', |
af31090c |
575 | TMPDIR => 1, |
576 | CLEANUP => 1, |
577 | ); |
578 | |
79193756 |
579 | $self->{dump_directory} ||= $self->{temp_directory}; |
580 | |
01012543 |
581 | $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION); |
1c95b304 |
582 | $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION); |
01012543 |
583 | |
66afce69 |
584 | if ((not ref $self->naming) && defined $self->naming) { |
9cc8e7e1 |
585 | my $naming_ver = $self->naming; |
a8d229ff |
586 | $self->{naming} = { |
587 | relationships => $naming_ver, |
588 | monikers => $naming_ver, |
f3a657ef |
589 | column_accessors => $naming_ver, |
a8d229ff |
590 | }; |
591 | } |
592 | |
66afce69 |
593 | if ($self->naming) { |
594 | for (values %{ $self->naming }) { |
c5df7397 |
595 | $_ = $CURRENT_V if $_ eq 'current'; |
66afce69 |
596 | } |
597 | } |
598 | $self->{naming} ||= {}; |
599 | |
d67d058e |
600 | if ($self->custom_column_info && ref $self->custom_column_info ne 'CODE') { |
601 | croak 'custom_column_info must be a CODE ref'; |
602 | } |
603 | |
7824616e |
604 | $self->_check_back_compat; |
9c465d2c |
605 | |
f22644d7 |
606 | $self->use_namespaces(1) unless defined $self->use_namespaces; |
492dce8d |
607 | $self->generate_pod(1) unless defined $self->generate_pod; |
43b982ea |
608 | $self->pod_comment_mode('auto') unless defined $self->pod_comment_mode; |
609 | $self->pod_comment_spillover_length(60) unless defined $self->pod_comment_spillover_length; |
f22644d7 |
610 | |
7824616e |
611 | $self; |
612 | } |
af31090c |
613 | |
7824616e |
614 | sub _check_back_compat { |
615 | my ($self) = @_; |
e8ad6491 |
616 | |
a8d229ff |
617 | # dynamic schemas will always be in 0.04006 mode, unless overridden |
106a976a |
618 | if ($self->dynamic) { |
fb3bb595 |
619 | # just in case, though no one is likely to dump a dynamic schema |
1c95b304 |
620 | $self->schema_version_to_dump('0.04006'); |
a8d229ff |
621 | |
66afce69 |
622 | if (not %{ $self->naming }) { |
623 | warn <<EOF unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; |
624 | |
625 | Dynamic schema detected, will run in 0.04006 mode. |
626 | |
627 | Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable |
628 | to disable this warning. |
a0e0a56a |
629 | |
805dbe0a |
630 | Also consider setting 'use_namespaces => 1' if/when upgrading. |
631 | |
a0e0a56a |
632 | See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more |
633 | details. |
66afce69 |
634 | EOF |
635 | } |
f53dcdf0 |
636 | else { |
637 | $self->_upgrading_from('v4'); |
638 | } |
66afce69 |
639 | |
a8d229ff |
640 | $self->naming->{relationships} ||= 'v4'; |
641 | $self->naming->{monikers} ||= 'v4'; |
642 | |
805dbe0a |
643 | if ($self->use_namespaces) { |
644 | $self->_upgrading_from_load_classes(1); |
645 | } |
646 | else { |
647 | $self->use_namespaces(0); |
648 | } |
f22644d7 |
649 | |
01012543 |
650 | return; |
651 | } |
652 | |
653 | # otherwise check if we need backcompat mode for a static schema |
7824616e |
654 | my $filename = $self->_get_dump_filename($self->schema_class); |
655 | return unless -e $filename; |
656 | |
8de81918 |
657 | my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom) = |
658 | $self->_parse_generated_file($filename); |
7824616e |
659 | |
8de81918 |
660 | return unless $old_ver; |
661 | |
662 | # determine if the existing schema was dumped with use_moose => 1 |
663 | if (! defined $self->use_moose) { |
53e721bc |
664 | $self->{use_moose} = 1 if $old_gen =~ /^ (?!\s*\#) use \s+ Moose/xm; |
8de81918 |
665 | } |
f22644d7 |
666 | |
8de81918 |
667 | my $load_classes = ($old_gen =~ /^__PACKAGE__->load_classes;/m) ? 1 : 0; |
668 | my $result_namespace = do { ($old_gen =~ /result_namespace => '([^']+)'/) ? $1 : '' }; |
805dbe0a |
669 | |
8de81918 |
670 | if ($load_classes && (not defined $self->use_namespaces)) { |
671 | warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; |
805dbe0a |
672 | |
a1a91c42 |
673 | 'load_classes;' static schema detected, turning off 'use_namespaces'. |
805dbe0a |
674 | |
675 | Set the 'use_namespaces' attribute or the SCHEMA_LOADER_BACKCOMPAT environment |
676 | variable to disable this warning. |
677 | |
678 | See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more |
679 | details. |
680 | EOF |
8de81918 |
681 | $self->use_namespaces(0); |
682 | } |
683 | elsif ($load_classes && $self->use_namespaces) { |
684 | $self->_upgrading_from_load_classes(1); |
685 | } |
686 | elsif ((not $load_classes) && defined $self->use_namespaces && ! $self->use_namespaces) { |
687 | $self->_downgrading_to_load_classes( |
688 | $result_namespace || 'Result' |
689 | ); |
690 | } |
691 | elsif ((not defined $self->use_namespaces) || $self->use_namespaces) { |
692 | if (not $self->result_namespace) { |
693 | $self->result_namespace($result_namespace || 'Result'); |
694 | } |
695 | elsif ($result_namespace ne $self->result_namespace) { |
696 | $self->_rewriting_result_namespace( |
697 | $result_namespace || 'Result' |
698 | ); |
699 | } |
700 | } |
a8d229ff |
701 | |
8de81918 |
702 | # XXX when we go past .0 this will need fixing |
703 | my ($v) = $old_ver =~ /([1-9])/; |
704 | $v = "v$v"; |
a8d229ff |
705 | |
8de81918 |
706 | return if ($v eq $CURRENT_V || $old_ver =~ /^0\.\d\d999/); |
a0e0a56a |
707 | |
8de81918 |
708 | if (not %{ $self->naming }) { |
709 | warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; |
a0e0a56a |
710 | |
8de81918 |
711 | Version $old_ver static schema detected, turning on backcompat mode. |
a0e0a56a |
712 | |
713 | Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable |
714 | to disable this warning. |
715 | |
9990e58f |
716 | See: 'naming' in perldoc DBIx::Class::Schema::Loader::Base . |
717 | |
2a8e93e9 |
718 | See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 if upgrading |
719 | from version 0.04006. |
a0e0a56a |
720 | EOF |
a8d229ff |
721 | |
8de81918 |
722 | $self->naming->{relationships} ||= $v; |
723 | $self->naming->{monikers} ||= $v; |
724 | $self->naming->{column_accessors} ||= $v; |
a0e0a56a |
725 | |
8de81918 |
726 | $self->schema_version_to_dump($old_ver); |
727 | } |
728 | else { |
729 | $self->_upgrading_from($v); |
7824616e |
730 | } |
996be9ee |
731 | } |
732 | |
8048320c |
733 | sub _validate_class_args { |
734 | my $self = shift; |
735 | my $args = shift; |
8de81918 |
736 | |
c5df7397 |
737 | foreach my $k (@CLASS_ARGS) { |
8048320c |
738 | next unless $self->$k; |
739 | |
740 | my @classes = ref $self->$k eq 'ARRAY' ? @{ $self->$k } : $self->$k; |
741 | foreach my $c (@classes) { |
742 | # components default to being under the DBIx::Class namespace unless they |
743 | # are preceeded with a '+' |
744 | if ( $k =~ m/components$/ && $c !~ s/^\+// ) { |
745 | $c = 'DBIx::Class::' . $c; |
746 | } |
747 | |
748 | # 1 == installed, 0 == not installed, undef == invalid classname |
749 | my $installed = Class::Inspector->installed($c); |
750 | if ( defined($installed) ) { |
751 | if ( $installed == 0 ) { |
752 | croak qq/$c, as specified in the loader option "$k", is not installed/; |
753 | } |
754 | } else { |
755 | croak qq/$c, as specified in the loader option "$k", is an invalid class name/; |
756 | } |
757 | } |
758 | } |
759 | } |
760 | |
419a2eeb |
761 | sub _find_file_in_inc { |
762 | my ($self, $file) = @_; |
763 | |
764 | foreach my $prefix (@INC) { |
af31090c |
765 | my $fullpath = File::Spec->catfile($prefix, $file); |
766 | return $fullpath if -f $fullpath |
281d0f3e |
767 | # abs_path throws on Windows for nonexistant files |
768 | and eval { Cwd::abs_path($fullpath) } ne |
769 | (eval { Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) } || ''); |
419a2eeb |
770 | } |
771 | |
772 | return; |
773 | } |
774 | |
fb3bb595 |
775 | sub _class_path { |
f96ef30f |
776 | my ($self, $class) = @_; |
777 | |
778 | my $class_path = $class; |
779 | $class_path =~ s{::}{/}g; |
780 | $class_path .= '.pm'; |
781 | |
fb3bb595 |
782 | return $class_path; |
783 | } |
784 | |
785 | sub _find_class_in_inc { |
786 | my ($self, $class) = @_; |
787 | |
788 | return $self->_find_file_in_inc($self->_class_path($class)); |
789 | } |
790 | |
a4b94090 |
791 | sub _rewriting { |
792 | my $self = shift; |
793 | |
794 | return $self->_upgrading_from |
795 | || $self->_upgrading_from_load_classes |
540a8149 |
796 | || $self->_downgrading_to_load_classes |
797 | || $self->_rewriting_result_namespace |
798 | ; |
a4b94090 |
799 | } |
800 | |
b24cb177 |
801 | sub _rewrite_old_classnames { |
802 | my ($self, $code) = @_; |
803 | |
a4b94090 |
804 | return $code unless $self->_rewriting; |
b24cb177 |
805 | |
806 | my %old_classes = reverse %{ $self->_upgrading_classes }; |
807 | |
808 | my $re = join '|', keys %old_classes; |
809 | $re = qr/\b($re)\b/; |
810 | |
68d49e50 |
811 | $code =~ s/$re/$old_classes{$1} || $1/eg; |
b24cb177 |
812 | |
813 | return $code; |
814 | } |
815 | |
fb3bb595 |
816 | sub _load_external { |
817 | my ($self, $class) = @_; |
818 | |
0ca61324 |
819 | return if $self->{skip_load_external}; |
820 | |
ffc705f3 |
821 | # so that we don't load our own classes, under any circumstances |
822 | local *INC = [ grep $_ ne $self->dump_directory, @INC ]; |
823 | |
fb3bb595 |
824 | my $real_inc_path = $self->_find_class_in_inc($class); |
f96ef30f |
825 | |
ffc705f3 |
826 | my $old_class = $self->_upgrading_classes->{$class} |
a4b94090 |
827 | if $self->_rewriting; |
ffc705f3 |
828 | |
829 | my $old_real_inc_path = $self->_find_class_in_inc($old_class) |
830 | if $old_class && $old_class ne $class; |
831 | |
832 | return unless $real_inc_path || $old_real_inc_path; |
833 | |
834 | if ($real_inc_path) { |
835 | # If we make it to here, we loaded an external definition |
836 | warn qq/# Loaded external class definition for '$class'\n/ |
837 | if $self->debug; |
838 | |
839 | open(my $fh, '<', $real_inc_path) |
840 | or croak "Failed to open '$real_inc_path' for reading: $!"; |
b24cb177 |
841 | my $code = do { local $/; <$fh> }; |
ffc705f3 |
842 | close($fh) |
843 | or croak "Failed to close $real_inc_path: $!"; |
b24cb177 |
844 | $code = $self->_rewrite_old_classnames($code); |
ffc705f3 |
845 | |
846 | if ($self->dynamic) { # load the class too |
c38ec663 |
847 | eval_without_redefine_warnings($code); |
ffc705f3 |
848 | } |
b24cb177 |
849 | |
850 | $self->_ext_stmt($class, |
851 | qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n| |
852 | .qq|# They are now part of the custom portion of this file\n| |
853 | .qq|# for you to hand-edit. If you do not either delete\n| |
854 | .qq|# this section or remove that file from \@INC, this section\n| |
855 | .qq|# will be repeated redundantly when you re-create this\n| |
e770e9ce |
856 | .qq|# file again via Loader! See skip_load_external to disable\n| |
857 | .qq|# this feature.\n| |
b24cb177 |
858 | ); |
859 | chomp $code; |
860 | $self->_ext_stmt($class, $code); |
861 | $self->_ext_stmt($class, |
862 | qq|# End of lines loaded from '$real_inc_path' | |
863 | ); |
996be9ee |
864 | } |
106a976a |
865 | |
ffc705f3 |
866 | if ($old_real_inc_path) { |
b511f36e |
867 | my $code = slurp $old_real_inc_path; |
868 | |
ffc705f3 |
869 | $self->_ext_stmt($class, <<"EOF"); |
870 | |
30a4c064 |
871 | # These lines were loaded from '$old_real_inc_path', |
b08ea624 |
872 | # based on the Result class name that would have been created by an older |
30a4c064 |
873 | # version of the Loader. For a static schema, this happens only once during |
e770e9ce |
874 | # upgrade. See skip_load_external to disable this feature. |
ffc705f3 |
875 | EOF |
b24cb177 |
876 | |
b24cb177 |
877 | $code = $self->_rewrite_old_classnames($code); |
878 | |
ffc705f3 |
879 | if ($self->dynamic) { |
880 | warn <<"EOF"; |
881 | |
882 | Detected external content in '$old_real_inc_path', a class name that would have |
b08ea624 |
883 | been used by an older version of the Loader. |
ffc705f3 |
884 | |
885 | * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the |
886 | new name of the Result. |
887 | EOF |
c38ec663 |
888 | eval_without_redefine_warnings($code); |
ffc705f3 |
889 | } |
890 | |
b24cb177 |
891 | chomp $code; |
892 | $self->_ext_stmt($class, $code); |
ffc705f3 |
893 | $self->_ext_stmt($class, |
894 | qq|# End of lines loaded from '$old_real_inc_path' | |
895 | ); |
9e8033c1 |
896 | } |
996be9ee |
897 | } |
898 | |
899 | =head2 load |
900 | |
901 | Does the actual schema-construction work. |
902 | |
903 | =cut |
904 | |
905 | sub load { |
906 | my $self = shift; |
907 | |
bfb43060 |
908 | $self->_load_tables( |
909 | $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude }) |
910 | ); |
b97c2c1e |
911 | } |
912 | |
913 | =head2 rescan |
914 | |
a60b5b8d |
915 | Arguments: schema |
916 | |
b511f36e |
917 | Rescan the database for changes. Returns a list of the newly added table |
918 | monikers. |
a60b5b8d |
919 | |
b511f36e |
920 | The schema argument should be the schema class or object to be affected. It |
921 | should probably be derived from the original schema_class used during L</load>. |
b97c2c1e |
922 | |
923 | =cut |
924 | |
925 | sub rescan { |
a60b5b8d |
926 | my ($self, $schema) = @_; |
927 | |
928 | $self->{schema} = $schema; |
7824616e |
929 | $self->_relbuilder->{schema} = $schema; |
b97c2c1e |
930 | |
931 | my @created; |
bfb43060 |
932 | my @current = $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude }); |
0c1d5b47 |
933 | |
bfb43060 |
934 | foreach my $table (@current) { |
b97c2c1e |
935 | if(!exists $self->{_tables}->{$table}) { |
936 | push(@created, $table); |
937 | } |
938 | } |
939 | |
0c1d5b47 |
940 | my %current; |
941 | @current{@current} = (); |
942 | foreach my $table (keys %{ $self->{_tables} }) { |
943 | if (not exists $current{$table}) { |
944 | $self->_unregister_source_for_table($table); |
945 | } |
946 | } |
947 | |
b511f36e |
948 | delete $self->{_dump_storage}; |
949 | delete $self->{_relations_started}; |
950 | |
951 | my $loaded = $self->_load_tables(@current); |
a60b5b8d |
952 | |
b511f36e |
953 | return map { $self->monikers->{$_} } @created; |
b97c2c1e |
954 | } |
955 | |
7824616e |
956 | sub _relbuilder { |
957 | my ($self) = @_; |
3fed44ca |
958 | |
959 | return if $self->{skip_relationships}; |
960 | |
ef372cf4 |
961 | return $self->{relbuilder} ||= do { |
962 | |
963 | no warnings 'uninitialized'; |
964 | my $relbuilder_suff = |
965 | {qw{ |
966 | v4 ::Compat::v0_040 |
967 | v5 ::Compat::v0_05 |
968 | v6 ::Compat::v0_06 |
969 | }} |
970 | ->{ $self->naming->{relationships}}; |
971 | |
972 | my $relbuilder_class = 'DBIx::Class::Schema::Loader::RelBuilder'.$relbuilder_suff; |
973 | eval "require $relbuilder_class"; die $@ if $@; |
974 | $relbuilder_class->new( $self ); |
a8d229ff |
975 | |
ef372cf4 |
976 | }; |
7824616e |
977 | } |
978 | |
b97c2c1e |
979 | sub _load_tables { |
980 | my ($self, @tables) = @_; |
981 | |
b97c2c1e |
982 | # Save the new tables to the tables list |
a60b5b8d |
983 | foreach (@tables) { |
984 | $self->{_tables}->{$_} = 1; |
985 | } |
f96ef30f |
986 | |
af31090c |
987 | $self->_make_src_class($_) for @tables; |
27305cc1 |
988 | |
27305cc1 |
989 | # sanity-check for moniker clashes |
990 | my $inverse_moniker_idx; |
991 | for (keys %{$self->monikers}) { |
992 | push @{$inverse_moniker_idx->{$self->monikers->{$_}}}, $_; |
993 | } |
994 | |
995 | my @clashes; |
996 | for (keys %$inverse_moniker_idx) { |
997 | my $tables = $inverse_moniker_idx->{$_}; |
998 | if (@$tables > 1) { |
999 | push @clashes, sprintf ("tables %s reduced to the same source moniker '%s'", |
1000 | join (', ', map { "'$_'" } @$tables), |
1001 | $_, |
1002 | ); |
1003 | } |
1004 | } |
1005 | |
1006 | if (@clashes) { |
1007 | die 'Unable to load schema - chosen moniker/class naming style results in moniker clashes. ' |
1008 | . 'Either change the naming style, or supply an explicit moniker_map: ' |
1009 | . join ('; ', @clashes) |
1010 | . "\n" |
1011 | ; |
1012 | } |
1013 | |
1014 | |
f96ef30f |
1015 | $self->_setup_src_meta($_) for @tables; |
1016 | |
e8ad6491 |
1017 | if(!$self->skip_relationships) { |
181cc907 |
1018 | # The relationship loader needs a working schema |
af31090c |
1019 | $self->{quiet} = 1; |
79193756 |
1020 | local $self->{dump_directory} = $self->{temp_directory}; |
106a976a |
1021 | $self->_reload_classes(\@tables); |
e8ad6491 |
1022 | $self->_load_relationships($_) for @tables; |
af31090c |
1023 | $self->{quiet} = 0; |
79193756 |
1024 | |
1025 | # Remove that temp dir from INC so it doesn't get reloaded |
ffc705f3 |
1026 | @INC = grep $_ ne $self->dump_directory, @INC; |
e8ad6491 |
1027 | } |
1028 | |
f96ef30f |
1029 | $self->_load_external($_) |
75451704 |
1030 | for map { $self->classes->{$_} } @tables; |
f96ef30f |
1031 | |
106a976a |
1032 | # Reload without unloading first to preserve any symbols from external |
1033 | # packages. |
1034 | $self->_reload_classes(\@tables, 0); |
996be9ee |
1035 | |
5223f24a |
1036 | # Drop temporary cache |
1037 | delete $self->{_cache}; |
1038 | |
c39e3507 |
1039 | return \@tables; |
996be9ee |
1040 | } |
1041 | |
af31090c |
1042 | sub _reload_classes { |
106a976a |
1043 | my ($self, $tables, $unload) = @_; |
1044 | |
1045 | my @tables = @$tables; |
1046 | $unload = 1 unless defined $unload; |
181cc907 |
1047 | |
4daef04f |
1048 | # so that we don't repeat custom sections |
1049 | @INC = grep $_ ne $self->dump_directory, @INC; |
1050 | |
181cc907 |
1051 | $self->_dump_to_dir(map { $self->classes->{$_} } @tables); |
e9b8719e |
1052 | |
1053 | unshift @INC, $self->dump_directory; |
af31090c |
1054 | |
706ef173 |
1055 | my @to_register; |
1056 | my %have_source = map { $_ => $self->schema->source($_) } |
1057 | $self->schema->sources; |
1058 | |
181cc907 |
1059 | for my $table (@tables) { |
1060 | my $moniker = $self->monikers->{$table}; |
1061 | my $class = $self->classes->{$table}; |
0ae6b65d |
1062 | |
1063 | { |
1064 | no warnings 'redefine'; |
942bd5e0 |
1065 | local *Class::C3::reinitialize = sub {}; # to speed things up, reinitialized below |
0ae6b65d |
1066 | use warnings; |
1067 | |
01f93238 |
1068 | if (my $mc = $self->_moose_metaclass($class)) { |
1069 | $mc->make_mutable; |
c9cf9b4d |
1070 | } |
106a976a |
1071 | Class::Unload->unload($class) if $unload; |
706ef173 |
1072 | my ($source, $resultset_class); |
1073 | if ( |
1074 | ($source = $have_source{$moniker}) |
1075 | && ($resultset_class = $source->resultset_class) |
1076 | && ($resultset_class ne 'DBIx::Class::ResultSet') |
1077 | ) { |
1078 | my $has_file = Class::Inspector->loaded_filename($resultset_class); |
01f93238 |
1079 | if (my $mc = $self->_moose_metaclass($resultset_class)) { |
1080 | $mc->make_mutable; |
c9cf9b4d |
1081 | } |
106a976a |
1082 | Class::Unload->unload($resultset_class) if $unload; |
1083 | $self->_reload_class($resultset_class) if $has_file; |
0ae6b65d |
1084 | } |
106a976a |
1085 | $self->_reload_class($class); |
af31090c |
1086 | } |
706ef173 |
1087 | push @to_register, [$moniker, $class]; |
1088 | } |
af31090c |
1089 | |
706ef173 |
1090 | Class::C3->reinitialize; |
1091 | for (@to_register) { |
1092 | $self->schema->register_class(@$_); |
af31090c |
1093 | } |
1094 | } |
1095 | |
01f93238 |
1096 | sub _moose_metaclass { |
1097 | return undef unless $INC{'Class/MOP.pm'}; # if CMOP is not loaded the class could not have loaded in the 1st place |
1098 | |
1099 | my $mc = Class::MOP::class_of($_[1]) |
1100 | or return undef; |
1101 | |
1102 | return $mc->isa('Moose::Meta::Class') ? $mc : undef; |
1103 | } |
1104 | |
106a976a |
1105 | # We use this instead of ensure_class_loaded when there are package symbols we |
1106 | # want to preserve. |
1107 | sub _reload_class { |
1108 | my ($self, $class) = @_; |
1109 | |
1110 | my $class_path = $self->_class_path($class); |
1111 | delete $INC{ $class_path }; |
f53dcdf0 |
1112 | |
1113 | # kill redefined warnings |
c38ec663 |
1114 | eval { |
1115 | eval_without_redefine_warnings ("require $class"); |
f53dcdf0 |
1116 | }; |
c9cf9b4d |
1117 | die "Failed to reload class $class: $@" if $@; |
106a976a |
1118 | } |
1119 | |
996be9ee |
1120 | sub _get_dump_filename { |
1121 | my ($self, $class) = (@_); |
1122 | |
1123 | $class =~ s{::}{/}g; |
1124 | return $self->dump_directory . q{/} . $class . q{.pm}; |
1125 | } |
1126 | |
1127 | sub _ensure_dump_subdirs { |
1128 | my ($self, $class) = (@_); |
1129 | |
1130 | my @name_parts = split(/::/, $class); |
dd03ee1a |
1131 | pop @name_parts; # we don't care about the very last element, |
1132 | # which is a filename |
1133 | |
996be9ee |
1134 | my $dir = $self->dump_directory; |
7cab3ab7 |
1135 | while (1) { |
1136 | if(!-d $dir) { |
25328cc4 |
1137 | mkdir($dir) or croak "mkdir('$dir') failed: $!"; |
996be9ee |
1138 | } |
7cab3ab7 |
1139 | last if !@name_parts; |
1140 | $dir = File::Spec->catdir($dir, shift @name_parts); |
996be9ee |
1141 | } |
1142 | } |
1143 | |
1144 | sub _dump_to_dir { |
af31090c |
1145 | my ($self, @classes) = @_; |
996be9ee |
1146 | |
fc2b71fd |
1147 | my $schema_class = $self->schema_class; |
9c9c2f2b |
1148 | my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema'; |
996be9ee |
1149 | |
e9b8719e |
1150 | my $target_dir = $self->dump_directory; |
af31090c |
1151 | warn "Dumping manual schema for $schema_class to directory $target_dir ...\n" |
1152 | unless $self->{dynamic} or $self->{quiet}; |
996be9ee |
1153 | |
7cab3ab7 |
1154 | my $schema_text = |
1155 | qq|package $schema_class;\n\n| |
b4dcbcc5 |
1156 | . qq|# Created by DBIx::Class::Schema::Loader\n| |
1157 | . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n| |
dcaf302a |
1158 | . qq|use strict;\nuse warnings;\n\n|; |
1159 | if ($self->use_moose) { |
c9cf9b4d |
1160 | $schema_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;\nextends '$schema_base_class';\n\n|; |
dcaf302a |
1161 | } |
1162 | else { |
1163 | $schema_text .= qq|use base '$schema_base_class';\n\n|; |
1164 | } |
f44ecc2f |
1165 | |
f44ecc2f |
1166 | if ($self->use_namespaces) { |
1167 | $schema_text .= qq|__PACKAGE__->load_namespaces|; |
1168 | my $namespace_options; |
2a8e93e9 |
1169 | |
1170 | my @attr = qw/resultset_namespace default_resultset_class/; |
1171 | |
1172 | unshift @attr, 'result_namespace' unless (not $self->result_namespace) || $self->result_namespace eq 'Result'; |
1173 | |
1174 | for my $attr (@attr) { |
f44ecc2f |
1175 | if ($self->$attr) { |
1176 | $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n| |
1177 | } |
1178 | } |
1179 | $schema_text .= qq|(\n$namespace_options)| if $namespace_options; |
1180 | $schema_text .= qq|;\n|; |
1181 | } |
1182 | else { |
1183 | $schema_text .= qq|__PACKAGE__->load_classes;\n|; |
f44ecc2f |
1184 | } |
996be9ee |
1185 | |
1c95b304 |
1186 | { |
1187 | local $self->{version_to_dump} = $self->schema_version_to_dump; |
68d49e50 |
1188 | $self->_write_classfile($schema_class, $schema_text, 1); |
1c95b304 |
1189 | } |
996be9ee |
1190 | |
2229729e |
1191 | my $result_base_class = $self->result_base_class || 'DBIx::Class::Core'; |
9c9c2f2b |
1192 | |
af31090c |
1193 | foreach my $src_class (@classes) { |
7cab3ab7 |
1194 | my $src_text = |
1195 | qq|package $src_class;\n\n| |
b4dcbcc5 |
1196 | . qq|# Created by DBIx::Class::Schema::Loader\n| |
1197 | . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n| |
dcaf302a |
1198 | . qq|use strict;\nuse warnings;\n\n|; |
1199 | if ($self->use_moose) { |
6c2b21a5 |
1200 | $src_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;|; |
1201 | |
1202 | # these options 'use base' which is compile time |
2b74a06b |
1203 | if (@{ $self->left_base_classes } || @{ $self->additional_base_classes }) { |
6c2b21a5 |
1204 | $src_text .= qq|\nBEGIN { extends '$result_base_class' }\n\n|; |
1205 | } |
1206 | else { |
1207 | $src_text .= qq|\nextends '$result_base_class';\n\n|; |
1208 | } |
dcaf302a |
1209 | } |
1210 | else { |
1211 | $src_text .= qq|use base '$result_base_class';\n\n|; |
1212 | } |
7cab3ab7 |
1213 | $self->_write_classfile($src_class, $src_text); |
02356864 |
1214 | } |
996be9ee |
1215 | |
a4b94090 |
1216 | # remove Result dir if downgrading from use_namespaces, and there are no |
1217 | # files left. |
b5f1b43c |
1218 | if (my $result_ns = $self->_downgrading_to_load_classes |
1219 | || $self->_rewriting_result_namespace) { |
540a8149 |
1220 | my $result_namespace = $self->_result_namespace( |
1221 | $schema_class, |
1222 | $result_ns, |
1223 | ); |
a4b94090 |
1224 | |
540a8149 |
1225 | (my $result_dir = $result_namespace) =~ s{::}{/}g; |
a4b94090 |
1226 | $result_dir = $self->dump_directory . '/' . $result_dir; |
1227 | |
1228 | unless (my @files = glob "$result_dir/*") { |
1229 | rmdir $result_dir; |
1230 | } |
1231 | } |
1232 | |
af31090c |
1233 | warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet}; |
1234 | |
7cab3ab7 |
1235 | } |
1236 | |
79193756 |
1237 | sub _sig_comment { |
1238 | my ($self, $version, $ts) = @_; |
1239 | return qq|\n\n# Created by DBIx::Class::Schema::Loader| |
1240 | . qq| v| . $version |
1241 | . q| @ | . $ts |
1242 | . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|; |
1243 | } |
1244 | |
7cab3ab7 |
1245 | sub _write_classfile { |
68d49e50 |
1246 | my ($self, $class, $text, $is_schema) = @_; |
7cab3ab7 |
1247 | |
1248 | my $filename = $self->_get_dump_filename($class); |
1249 | $self->_ensure_dump_subdirs($class); |
1250 | |
28b4691d |
1251 | if (-f $filename && $self->really_erase_my_files) { |
7cab3ab7 |
1252 | warn "Deleting existing file '$filename' due to " |
af31090c |
1253 | . "'really_erase_my_files' setting\n" unless $self->{quiet}; |
7cab3ab7 |
1254 | unlink($filename); |
8de81918 |
1255 | } |
7cab3ab7 |
1256 | |
8de81918 |
1257 | my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom) |
1258 | = $self->_parse_generated_file($filename); |
17ca645f |
1259 | |
8de81918 |
1260 | if (! $old_gen && -f $filename) { |
1261 | croak "Cannot overwrite '$filename' without 'really_erase_my_files'," |
1262 | . " it does not appear to have been generated by Loader" |
1263 | } |
c9cf9b4d |
1264 | |
8de81918 |
1265 | my $custom_content = $old_custom || ''; |
c9cf9b4d |
1266 | |
8de81918 |
1267 | # prepend extra custom content from a *renamed* class (singularization effect) |
1268 | if (my $renamed_class = $self->_upgrading_classes->{$class}) { |
1269 | my $old_filename = $self->_get_dump_filename($renamed_class); |
c9cf9b4d |
1270 | |
8de81918 |
1271 | if (-f $old_filename) { |
1272 | my $extra_custom = ($self->_parse_generated_file ($old_filename))[4]; |
1273 | |
1274 | $extra_custom =~ s/\n\n# You can replace.*\n1;\n//; |
1275 | |
1276 | $custom_content = join ("\n", '', $extra_custom, $custom_content) |
1277 | if $extra_custom; |
1278 | |
1279 | unlink $old_filename; |
c9cf9b4d |
1280 | } |
1281 | } |
1282 | |
8de81918 |
1283 | $custom_content ||= $self->_default_custom_content; |
f53dcdf0 |
1284 | |
8de81918 |
1285 | # If upgrading to use_moose=1 replace default custom content with default Moose custom content. |
1286 | # If there is already custom content, which does not have the Moose content, add it. |
1287 | if ($self->use_moose) { |
ffc705f3 |
1288 | |
8de81918 |
1289 | my $non_moose_custom_content = do { |
1290 | local $self->{use_moose} = 0; |
1291 | $self->_default_custom_content; |
1292 | }; |
f53dcdf0 |
1293 | |
8de81918 |
1294 | if ($custom_content eq $non_moose_custom_content) { |
1295 | $custom_content = $self->_default_custom_content; |
1296 | } |
1297 | elsif ($custom_content !~ /\Q@{[$self->_default_moose_custom_content]}\E/) { |
1298 | $custom_content .= $self->_default_custom_content; |
f53dcdf0 |
1299 | } |
1300 | } |
22edddda |
1301 | elsif (defined $self->use_moose && $old_gen) { |
1302 | croak 'It is not possible to "downgrade" a schema that was loaded with use_moose => 1 to use_moose => 0, due to differing custom content' |
1303 | if $old_gen =~ /use \s+ MooseX?\b/x; |
1304 | } |
f53dcdf0 |
1305 | |
b24cb177 |
1306 | $custom_content = $self->_rewrite_old_classnames($custom_content); |
1307 | |
7cab3ab7 |
1308 | $text .= qq|$_\n| |
1309 | for @{$self->{_dump_storage}->{$class} || []}; |
1310 | |
79193756 |
1311 | # Check and see if the dump is infact differnt |
1312 | |
1313 | my $compare_to; |
1314 | if ($old_md5) { |
1315 | $compare_to = $text . $self->_sig_comment($old_ver, $old_ts); |
79193756 |
1316 | if (Digest::MD5::md5_base64($compare_to) eq $old_md5) { |
68d49e50 |
1317 | return unless $self->_upgrading_from && $is_schema; |
79193756 |
1318 | } |
1319 | } |
1320 | |
1321 | $text .= $self->_sig_comment( |
01012543 |
1322 | $self->version_to_dump, |
79193756 |
1323 | POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime) |
1324 | ); |
7cab3ab7 |
1325 | |
1326 | open(my $fh, '>', $filename) |
1327 | or croak "Cannot open '$filename' for writing: $!"; |
1328 | |
1329 | # Write the top half and its MD5 sum |
a4476f41 |
1330 | print $fh $text . Digest::MD5::md5_base64($text) . "\n"; |
7cab3ab7 |
1331 | |
1332 | # Write out anything loaded via external partial class file in @INC |
1333 | print $fh qq|$_\n| |
1334 | for @{$self->{_ext_storage}->{$class} || []}; |
1335 | |
1eea4fb1 |
1336 | # Write out any custom content the user has added |
7cab3ab7 |
1337 | print $fh $custom_content; |
1338 | |
1339 | close($fh) |
e9b8719e |
1340 | or croak "Error closing '$filename': $!"; |
7cab3ab7 |
1341 | } |
1342 | |
c9cf9b4d |
1343 | sub _default_moose_custom_content { |
1344 | return qq|\n__PACKAGE__->meta->make_immutable;|; |
1345 | } |
1346 | |
79193756 |
1347 | sub _default_custom_content { |
dcaf302a |
1348 | my $self = shift; |
1349 | my $default = qq|\n\n# You can replace this text with custom| |
1350 | . qq| content, and it will be preserved on regeneration|; |
1351 | if ($self->use_moose) { |
c9cf9b4d |
1352 | $default .= $self->_default_moose_custom_content; |
dcaf302a |
1353 | } |
1354 | $default .= qq|\n1;\n|; |
1355 | return $default; |
79193756 |
1356 | } |
1357 | |
8de81918 |
1358 | sub _parse_generated_file { |
1359 | my ($self, $fn) = @_; |
7cab3ab7 |
1360 | |
8de81918 |
1361 | return unless -f $fn; |
79193756 |
1362 | |
8de81918 |
1363 | open(my $fh, '<', $fn) |
1364 | or croak "Cannot open '$fn' for reading: $!"; |
7cab3ab7 |
1365 | |
8de81918 |
1366 | my $mark_re = |
419a2eeb |
1367 | qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n}; |
7cab3ab7 |
1368 | |
8de81918 |
1369 | my ($md5, $ts, $ver, $gen); |
7cab3ab7 |
1370 | while(<$fh>) { |
8de81918 |
1371 | if(/$mark_re/) { |
1372 | my $pre_md5 = $1; |
79193756 |
1373 | $md5 = $2; |
79193756 |
1374 | |
8de81918 |
1375 | # Pull out the version and timestamp from the line above |
1376 | ($ver, $ts) = $gen =~ m/^# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)\Z/m; |
79193756 |
1377 | |
8de81918 |
1378 | $gen .= $pre_md5; |
1379 | croak "Checksum mismatch in '$fn', the auto-generated part of the file has been modified outside of this loader. Aborting.\nIf you want to overwrite these modifications, set the 'overwrite_modifications' loader option.\n" |
1380 | if !$self->overwrite_modifications && Digest::MD5::md5_base64($gen) ne $md5; |
7cab3ab7 |
1381 | |
8de81918 |
1382 | last; |
7cab3ab7 |
1383 | } |
1384 | else { |
8de81918 |
1385 | $gen .= $_; |
7cab3ab7 |
1386 | } |
996be9ee |
1387 | } |
1388 | |
8de81918 |
1389 | my $custom = do { local $/; <$fh> } |
1390 | if $md5; |
5ef3c771 |
1391 | |
8de81918 |
1392 | close ($fh); |
5ef3c771 |
1393 | |
8de81918 |
1394 | return ($gen, $md5, $ver, $ts, $custom); |
996be9ee |
1395 | } |
1396 | |
1397 | sub _use { |
1398 | my $self = shift; |
1399 | my $target = shift; |
1400 | |
1401 | foreach (@_) { |
cb54990b |
1402 | warn "$target: use $_;" if $self->debug; |
996be9ee |
1403 | $self->_raw_stmt($target, "use $_;"); |
996be9ee |
1404 | } |
1405 | } |
1406 | |
1407 | sub _inject { |
1408 | my $self = shift; |
1409 | my $target = shift; |
996be9ee |
1410 | |
af31090c |
1411 | my $blist = join(q{ }, @_); |
6c2b21a5 |
1412 | |
1413 | return unless $blist; |
1414 | |
1415 | warn "$target: use base qw/$blist/;" if $self->debug; |
1416 | $self->_raw_stmt($target, "use base qw/$blist/;"); |
996be9ee |
1417 | } |
1418 | |
540a8149 |
1419 | sub _result_namespace { |
1420 | my ($self, $schema_class, $ns) = @_; |
1421 | my @result_namespace; |
1422 | |
1423 | if ($ns =~ /^\+(.*)/) { |
1424 | # Fully qualified namespace |
1425 | @result_namespace = ($1) |
1426 | } |
1427 | else { |
1428 | # Relative namespace |
1429 | @result_namespace = ($schema_class, $ns); |
1430 | } |
1431 | |
1432 | return wantarray ? @result_namespace : join '::', @result_namespace; |
1433 | } |
1434 | |
f96ef30f |
1435 | # Create class with applicable bases, setup monikers, etc |
1436 | sub _make_src_class { |
1437 | my ($self, $table) = @_; |
996be9ee |
1438 | |
a13b2803 |
1439 | my $schema = $self->schema; |
1440 | my $schema_class = $self->schema_class; |
996be9ee |
1441 | |
f96ef30f |
1442 | my $table_moniker = $self->_table2moniker($table); |
f44ecc2f |
1443 | my @result_namespace = ($schema_class); |
1444 | if ($self->use_namespaces) { |
1445 | my $result_namespace = $self->result_namespace || 'Result'; |
540a8149 |
1446 | @result_namespace = $self->_result_namespace( |
1447 | $schema_class, |
1448 | $result_namespace, |
1449 | ); |
f44ecc2f |
1450 | } |
1451 | my $table_class = join(q{::}, @result_namespace, $table_moniker); |
996be9ee |
1452 | |
805dbe0a |
1453 | if ((my $upgrading_v = $self->_upgrading_from) |
a4b94090 |
1454 | || $self->_rewriting) { |
805dbe0a |
1455 | local $self->naming->{monikers} = $upgrading_v |
1456 | if $upgrading_v; |
1457 | |
1458 | my @result_namespace = @result_namespace; |
a4b94090 |
1459 | if ($self->_upgrading_from_load_classes) { |
1460 | @result_namespace = ($schema_class); |
1461 | } |
1462 | elsif (my $ns = $self->_downgrading_to_load_classes) { |
540a8149 |
1463 | @result_namespace = $self->_result_namespace( |
1464 | $schema_class, |
1465 | $ns, |
1466 | ); |
1467 | } |
1468 | elsif ($ns = $self->_rewriting_result_namespace) { |
1469 | @result_namespace = $self->_result_namespace( |
1470 | $schema_class, |
1471 | $ns, |
1472 | ); |
a4b94090 |
1473 | } |
f53dcdf0 |
1474 | |
1475 | my $old_class = join(q{::}, @result_namespace, |
1476 | $self->_table2moniker($table)); |
1477 | |
68d49e50 |
1478 | $self->_upgrading_classes->{$table_class} = $old_class |
1479 | unless $table_class eq $old_class; |
f53dcdf0 |
1480 | } |
1481 | |
bfb43060 |
1482 | # this was a bad idea, should be ok now without it |
1483 | # my $table_normalized = lc $table; |
1484 | # $self->classes->{$table_normalized} = $table_class; |
1485 | # $self->monikers->{$table_normalized} = $table_moniker; |
1486 | |
f96ef30f |
1487 | $self->classes->{$table} = $table_class; |
f96ef30f |
1488 | $self->monikers->{$table} = $table_moniker; |
996be9ee |
1489 | |
f96ef30f |
1490 | $self->_use ($table_class, @{$self->additional_classes}); |
af31090c |
1491 | $self->_inject($table_class, @{$self->left_base_classes}); |
996be9ee |
1492 | |
2229729e |
1493 | if (my @components = @{ $self->components }) { |
1494 | $self->_dbic_stmt($table_class, 'load_components', @components); |
1495 | } |
996be9ee |
1496 | |
f96ef30f |
1497 | $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components}) |
1498 | if @{$self->resultset_components}; |
af31090c |
1499 | $self->_inject($table_class, @{$self->additional_base_classes}); |
f96ef30f |
1500 | } |
996be9ee |
1501 | |
9fdf3d5b |
1502 | sub _resolve_col_accessor_collisions { |
1503 | my ($self, $col_info) = @_; |
1504 | |
1505 | my $base = $self->result_base_class || 'DBIx::Class::Core'; |
410e3f58 |
1506 | my @components = map "DBIx::Class::$_", @{ $self->components || [] }; |
9fdf3d5b |
1507 | |
1508 | my @methods; |
1509 | |
6c2b21a5 |
1510 | for my $class ($base, @components, $self->use_moose ? 'Moose::Object' : ()) { |
9fdf3d5b |
1511 | eval "require ${class};"; |
1512 | die $@ if $@; |
1513 | |
1514 | push @methods, @{ Class::Inspector->methods($class) || [] }; |
1515 | } |
1516 | |
1517 | my %methods; |
1518 | @methods{@methods} = (); |
1519 | |
6c2b21a5 |
1520 | # futureproof meta |
1521 | $methods{meta} = undef; |
1522 | |
9fdf3d5b |
1523 | while (my ($col, $info) = each %$col_info) { |
1524 | my $accessor = $info->{accessor} || $col; |
1525 | |
c9486c78 |
1526 | next if $accessor eq 'id'; # special case (very common column) |
9fdf3d5b |
1527 | |
1528 | if (exists $methods{$accessor}) { |
1e473081 |
1529 | $info->{accessor} = undef; |
9fdf3d5b |
1530 | } |
1531 | } |
1532 | } |
1533 | |
f3a657ef |
1534 | sub _make_column_accessor_name { |
1535 | my ($self, $column_name) = @_; |
1536 | |
cc4f11a2 |
1537 | return join '_', map lc, split_name $column_name; |
f3a657ef |
1538 | } |
1539 | |
af31090c |
1540 | # Set up metadata (cols, pks, etc) |
f96ef30f |
1541 | sub _setup_src_meta { |
1542 | my ($self, $table) = @_; |
996be9ee |
1543 | |
f96ef30f |
1544 | my $schema = $self->schema; |
1545 | my $schema_class = $self->schema_class; |
a13b2803 |
1546 | |
f96ef30f |
1547 | my $table_class = $self->classes->{$table}; |
1548 | my $table_moniker = $self->monikers->{$table}; |
996be9ee |
1549 | |
ff30991a |
1550 | my $table_name = $table; |
1551 | my $name_sep = $self->schema->storage->sql_maker->name_sep; |
1552 | |
c177d483 |
1553 | if ($name_sep && $table_name =~ /\Q$name_sep\E/) { |
ff30991a |
1554 | $table_name = \ $self->_quote_table_name($table_name); |
1555 | } |
1556 | |
b1d11550 |
1557 | my $full_table_name = ($self->qualify_objects ? ($self->db_schema . '.') : '') . (ref $table_name ? $$table_name : $table_name); |
1558 | |
1559 | # be careful to not create refs Data::Dump can "optimize" |
1560 | $full_table_name = \do {"".$full_table_name} if ref $table_name; |
1561 | |
1562 | $self->_dbic_stmt($table_class, 'table', $full_table_name); |
996be9ee |
1563 | |
f96ef30f |
1564 | my $cols = $self->_table_columns($table); |
45be2ce7 |
1565 | my $col_info = $self->__columns_info_for($table); |
df55c5fa |
1566 | |
1567 | while (my ($col, $info) = each %$col_info) { |
1568 | if ($col =~ /\W/) { |
1569 | ($info->{accessor} = $col) =~ s/\W+/_/g; |
1570 | } |
1571 | } |
1572 | |
bc1cb85e |
1573 | if ($self->preserve_case) { |
df55c5fa |
1574 | while (my ($col, $info) = each %$col_info) { |
f3a657ef |
1575 | if ($col ne lc($col)) { |
1576 | if ((not exists $self->naming->{column_accessors}) || (($self->naming->{column_accessors} =~ /(\d+)/)[0] >= 7)) { |
df55c5fa |
1577 | $info->{accessor} = $self->_make_column_accessor_name($info->{accessor} || $col); |
f3a657ef |
1578 | } |
1579 | else { |
df55c5fa |
1580 | $info->{accessor} = lc($info->{accessor} || $col); |
f3a657ef |
1581 | } |
1582 | } |
c9373b79 |
1583 | } |
c9486c78 |
1584 | } |
1585 | else { |
1586 | # XXX this needs to go away |
45be2ce7 |
1587 | $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info }; |
1588 | } |
c9373b79 |
1589 | |
9fdf3d5b |
1590 | $self->_resolve_col_accessor_collisions($col_info); |
1591 | |
45be2ce7 |
1592 | my $fks = $self->_table_fk_info($table); |
565335e6 |
1593 | |
10c0c4f3 |
1594 | foreach my $fkdef (@$fks) { |
45be2ce7 |
1595 | for my $col (@{ $fkdef->{local_columns} }) { |
1596 | $col_info->{$col}{is_foreign_key} = 1; |
e7213f4f |
1597 | } |
996be9ee |
1598 | } |
10c0c4f3 |
1599 | |
1600 | my $pks = $self->_table_pk_info($table) || []; |
1601 | |
1602 | foreach my $pkcol (@$pks) { |
1603 | $col_info->{$pkcol}{is_nullable} = 0; |
1604 | } |
1605 | |
45be2ce7 |
1606 | $self->_dbic_stmt( |
1607 | $table_class, |
1608 | 'add_columns', |
1609 | map { $_, ($col_info->{$_}||{}) } @$cols |
1610 | ); |
996be9ee |
1611 | |
d70c335f |
1612 | my %uniq_tag; # used to eliminate duplicate uniqs |
1613 | |
f96ef30f |
1614 | @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks) |
1615 | : carp("$table has no primary key"); |
d70c335f |
1616 | $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq |
996be9ee |
1617 | |
f96ef30f |
1618 | my $uniqs = $self->_table_uniq_info($table) || []; |
d70c335f |
1619 | for (@$uniqs) { |
1620 | my ($name, $cols) = @$_; |
1621 | next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates |
1622 | $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols); |
1623 | } |
1624 | |
996be9ee |
1625 | } |
1626 | |
d67d058e |
1627 | sub __columns_info_for { |
1628 | my ($self, $table) = @_; |
1629 | |
1630 | my $result = $self->_columns_info_for($table); |
1631 | |
1632 | while (my ($col, $info) = each %$result) { |
1633 | $info = { %$info, %{ $self->_custom_column_info ($table, $col, $info) } }; |
1634 | $info = { %$info, %{ $self->_datetime_column_info($table, $col, $info) } }; |
1635 | |
1636 | $result->{$col} = $info; |
1637 | } |
1638 | |
1639 | return $result; |
1640 | } |
1641 | |
996be9ee |
1642 | =head2 tables |
1643 | |
1644 | Returns a sorted list of loaded tables, using the original database table |
1645 | names. |
1646 | |
1647 | =cut |
1648 | |
1649 | sub tables { |
1650 | my $self = shift; |
1651 | |
b97c2c1e |
1652 | return keys %{$self->_tables}; |
996be9ee |
1653 | } |
1654 | |
1655 | # Make a moniker from a table |
c39e403e |
1656 | sub _default_table2moniker { |
66afce69 |
1657 | no warnings 'uninitialized'; |
c39e403e |
1658 | my ($self, $table) = @_; |
1659 | |
a8d229ff |
1660 | if ($self->naming->{monikers} eq 'v4') { |
1661 | return join '', map ucfirst, split /[\W_]+/, lc $table; |
1662 | } |
ecf930e6 |
1663 | elsif ($self->naming->{monikers} eq 'v5') { |
1664 | return join '', map ucfirst, split /[\W_]+/, |
1665 | Lingua::EN::Inflect::Number::to_S(lc $table); |
1666 | } |
9990e58f |
1667 | elsif ($self->naming->{monikers} eq 'v6') { |
1668 | (my $as_phrase = lc $table) =~ s/_+/ /g; |
1669 | my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase); |
1670 | |
1671 | return join '', map ucfirst, split /\W+/, $inflected; |
1672 | } |
1673 | |
cc4f11a2 |
1674 | my @words = map lc, split_name $table; |
9990e58f |
1675 | my $as_phrase = join ' ', @words; |
ecf930e6 |
1676 | |
ecf930e6 |
1677 | my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase); |
a8d229ff |
1678 | |
ecf930e6 |
1679 | return join '', map ucfirst, split /\W+/, $inflected; |
c39e403e |
1680 | } |
1681 | |
996be9ee |
1682 | sub _table2moniker { |
1683 | my ( $self, $table ) = @_; |
1684 | |
1685 | my $moniker; |
1686 | |
1687 | if( ref $self->moniker_map eq 'HASH' ) { |
1688 | $moniker = $self->moniker_map->{$table}; |
1689 | } |
1690 | elsif( ref $self->moniker_map eq 'CODE' ) { |
1691 | $moniker = $self->moniker_map->($table); |
1692 | } |
1693 | |
c39e403e |
1694 | $moniker ||= $self->_default_table2moniker($table); |
996be9ee |
1695 | |
1696 | return $moniker; |
1697 | } |
1698 | |
1699 | sub _load_relationships { |
e8ad6491 |
1700 | my ($self, $table) = @_; |
996be9ee |
1701 | |
e8ad6491 |
1702 | my $tbl_fk_info = $self->_table_fk_info($table); |
1703 | foreach my $fkdef (@$tbl_fk_info) { |
1704 | $fkdef->{remote_source} = |
1705 | $self->monikers->{delete $fkdef->{remote_table}}; |
996be9ee |
1706 | } |
26f1c8c9 |
1707 | my $tbl_uniq_info = $self->_table_uniq_info($table); |
996be9ee |
1708 | |
e8ad6491 |
1709 | my $local_moniker = $self->monikers->{$table}; |
7824616e |
1710 | my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info); |
996be9ee |
1711 | |
996be9ee |
1712 | foreach my $src_class (sort keys %$rel_stmts) { |
1713 | my $src_stmts = $rel_stmts->{$src_class}; |
1714 | foreach my $stmt (@$src_stmts) { |
1715 | $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}}); |
1716 | } |
1717 | } |
1718 | } |
1719 | |
1720 | # Overload these in driver class: |
1721 | |
1722 | # Returns an arrayref of column names |
1723 | sub _table_columns { croak "ABSTRACT METHOD" } |
1724 | |
1725 | # Returns arrayref of pk col names |
1726 | sub _table_pk_info { croak "ABSTRACT METHOD" } |
1727 | |
1728 | # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ] |
1729 | sub _table_uniq_info { croak "ABSTRACT METHOD" } |
1730 | |
1731 | # Returns an arrayref of foreign key constraints, each |
1732 | # being a hashref with 3 keys: |
1733 | # local_columns (arrayref), remote_columns (arrayref), remote_table |
1734 | sub _table_fk_info { croak "ABSTRACT METHOD" } |
1735 | |
1736 | # Returns an array of lower case table names |
1737 | sub _tables_list { croak "ABSTRACT METHOD" } |
1738 | |
1739 | # Execute a constructive DBIC class method, with debug/dump_to_dir hooks. |
1740 | sub _dbic_stmt { |
bf654ab9 |
1741 | my $self = shift; |
1742 | my $class = shift; |
996be9ee |
1743 | my $method = shift; |
bf654ab9 |
1744 | |
1745 | # generate the pod for this statement, storing it with $self->_pod |
43b982ea |
1746 | $self->_make_pod( $class, $method, @_ ) if $self->generate_pod; |
bf654ab9 |
1747 | |
1748 | my $args = dump(@_); |
1749 | $args = '(' . $args . ')' if @_ < 2; |
1750 | my $stmt = $method . $args . q{;}; |
1751 | |
1752 | warn qq|$class\->$stmt\n| if $self->debug; |
1753 | $self->_raw_stmt($class, '__PACKAGE__->' . $stmt); |
1754 | return; |
1755 | } |
1756 | |
1757 | # generates the accompanying pod for a DBIC class method statement, |
1758 | # storing it with $self->_pod |
1759 | sub _make_pod { |
1760 | my $self = shift; |
1761 | my $class = shift; |
1762 | my $method = shift; |
1763 | |
fbcfebdd |
1764 | if ( $method eq 'table' ) { |
1765 | my ($table) = @_; |
43b982ea |
1766 | my $pcm = $self->pod_comment_mode; |
1767 | my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc); |
fd97abca |
1768 | $comment = $self->__table_comment($table); |
1769 | $comment_overflows = ($comment and length $comment > $self->pod_comment_spillover_length); |
1770 | $comment_in_name = ($pcm eq 'name' or ($pcm eq 'auto' and !$comment_overflows)); |
1771 | $comment_in_desc = ($pcm eq 'description' or ($pcm eq 'auto' and $comment_overflows)); |
43b982ea |
1772 | $self->_pod( $class, "=head1 NAME" ); |
1773 | my $table_descr = $class; |
1774 | $table_descr .= " - " . $comment if $comment and $comment_in_name; |
fbcfebdd |
1775 | $self->{_class2table}{ $class } = $table; |
1776 | $self->_pod( $class, $table_descr ); |
43b982ea |
1777 | if ($comment and $comment_in_desc) { |
1778 | $self->_pod( $class, "=head1 DESCRIPTION" ); |
1779 | $self->_pod( $class, $comment ); |
1780 | } |
fbcfebdd |
1781 | $self->_pod_cut( $class ); |
1782 | } elsif ( $method eq 'add_columns' ) { |
1783 | $self->_pod( $class, "=head1 ACCESSORS" ); |
79a00530 |
1784 | my $col_counter = 0; |
1785 | my @cols = @_; |
1786 | while( my ($name,$attrs) = splice @cols,0,2 ) { |
1787 | $col_counter++; |
1788 | $self->_pod( $class, '=head2 ' . $name ); |
1789 | $self->_pod( $class, |
1790 | join "\n", map { |
1791 | my $s = $attrs->{$_}; |
fca5431b |
1792 | $s = !defined $s ? 'undef' : |
1793 | length($s) == 0 ? '(empty string)' : |
f170d55b |
1794 | ref($s) eq 'SCALAR' ? $$s : |
15efd63a |
1795 | ref($s) ? dumper_squashed $s : |
f170d55b |
1796 | looks_like_number($s) ? $s : |
1797 | qq{'$s'} |
fca5431b |
1798 | ; |
79a00530 |
1799 | |
1800 | " $_: $s" |
1801 | } sort keys %$attrs, |
1802 | ); |
1803 | |
fd97abca |
1804 | if (my $comment = $self->__column_comment($self->{_class2table}{$class}, $col_counter)) { |
79a00530 |
1805 | $self->_pod( $class, $comment ); |
1806 | } |
fbcfebdd |
1807 | } |
1808 | $self->_pod_cut( $class ); |
1809 | } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) { |
1810 | $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ; |
1811 | my ( $accessor, $rel_class ) = @_; |
1812 | $self->_pod( $class, "=head2 $accessor" ); |
1813 | $self->_pod( $class, 'Type: ' . $method ); |
1814 | $self->_pod( $class, "Related object: L<$rel_class>" ); |
1815 | $self->_pod_cut( $class ); |
1816 | $self->{_relations_started} { $class } = 1; |
1817 | } |
996be9ee |
1818 | } |
1819 | |
fd97abca |
1820 | sub _filter_comment { |
1821 | my ($self, $txt) = @_; |
1822 | |
1823 | $txt = '' if not defined $txt; |
1824 | |
1825 | $txt =~ s/(?:\015?\012|\015\012?)/\n/g; |
1826 | |
1827 | return $txt; |
1828 | } |
1829 | |
1830 | sub __table_comment { |
1831 | my $self = shift; |
1832 | |
1833 | if (my $code = $self->can('_table_comment')) { |
1834 | return $self->_filter_comment($self->$code(@_)); |
1835 | } |
1836 | |
1837 | return ''; |
1838 | } |
1839 | |
1840 | sub __column_comment { |
1841 | my $self = shift; |
1842 | |
1843 | if (my $code = $self->can('_column_comment')) { |
1844 | return $self->_filter_comment($self->$code(@_)); |
1845 | } |
1846 | |
1847 | return ''; |
1848 | } |
1849 | |
fbcfebdd |
1850 | # Stores a POD documentation |
1851 | sub _pod { |
1852 | my ($self, $class, $stmt) = @_; |
1853 | $self->_raw_stmt( $class, "\n" . $stmt ); |
1854 | } |
1855 | |
1856 | sub _pod_cut { |
1857 | my ($self, $class ) = @_; |
1858 | $self->_raw_stmt( $class, "\n=cut\n" ); |
1859 | } |
1860 | |
996be9ee |
1861 | # Store a raw source line for a class (for dumping purposes) |
1862 | sub _raw_stmt { |
1863 | my ($self, $class, $stmt) = @_; |
af31090c |
1864 | push(@{$self->{_dump_storage}->{$class}}, $stmt); |
996be9ee |
1865 | } |
1866 | |
7cab3ab7 |
1867 | # Like above, but separately for the externally loaded stuff |
1868 | sub _ext_stmt { |
1869 | my ($self, $class, $stmt) = @_; |
af31090c |
1870 | push(@{$self->{_ext_storage}->{$class}}, $stmt); |
7cab3ab7 |
1871 | } |
1872 | |
565335e6 |
1873 | sub _quote_table_name { |
1874 | my ($self, $table) = @_; |
1875 | |
1876 | my $qt = $self->schema->storage->sql_maker->quote_char; |
1877 | |
c177d483 |
1878 | return $table unless $qt; |
1879 | |
565335e6 |
1880 | if (ref $qt) { |
1881 | return $qt->[0] . $table . $qt->[1]; |
1882 | } |
1883 | |
1884 | return $qt . $table . $qt; |
1885 | } |
1886 | |
b639d969 |
1887 | sub _custom_column_info { |
23d1f36b |
1888 | my ( $self, $table_name, $column_name, $column_info ) = @_; |
b639d969 |
1889 | |
d67d058e |
1890 | if (my $code = $self->custom_column_info) { |
1891 | return $code->($table_name, $column_name, $column_info) || {}; |
b639d969 |
1892 | } |
3a368709 |
1893 | return {}; |
b639d969 |
1894 | } |
1895 | |
42e785fa |
1896 | sub _datetime_column_info { |
23d1f36b |
1897 | my ( $self, $table_name, $column_name, $column_info ) = @_; |
d67d058e |
1898 | my $result = {}; |
1899 | my $type = $column_info->{data_type} || ''; |
1900 | if ((grep $_, @{ $column_info }{map "inflate_$_", qw/date datetime timestamp/}) |
1901 | or ($type =~ /date|timestamp/i)) { |
1902 | $result->{timezone} = $self->datetime_timezone if $self->datetime_timezone; |
1903 | $result->{locale} = $self->datetime_locale if $self->datetime_locale; |
42e785fa |
1904 | } |
d67d058e |
1905 | return $result; |
42e785fa |
1906 | } |
1907 | |
bc1cb85e |
1908 | sub _lc { |
1909 | my ($self, $name) = @_; |
1910 | |
1911 | return $self->preserve_case ? $name : lc($name); |
1912 | } |
1913 | |
1914 | sub _uc { |
1915 | my ($self, $name) = @_; |
1916 | |
1917 | return $self->preserve_case ? $name : uc($name); |
1918 | } |
1919 | |
0c1d5b47 |
1920 | sub _unregister_source_for_table { |
1921 | my ($self, $table) = @_; |
1922 | |
1923 | eval { |
1924 | local $@; |
1925 | my $schema = $self->schema; |
1926 | # in older DBIC it's a private method |
1927 | my $unregister = $schema->can('unregister_source') || $schema->can('_unregister_source'); |
1928 | $schema->$unregister($self->_table2moniker($table)); |
1929 | delete $self->monikers->{$table}; |
1930 | delete $self->classes->{$table}; |
1931 | delete $self->_upgrading_classes->{$table}; |
1932 | delete $self->{_tables}{$table}; |
1933 | }; |
1934 | } |
1935 | |
ffc705f3 |
1936 | # remove the dump dir from @INC on destruction |
1937 | sub DESTROY { |
1938 | my $self = shift; |
1939 | |
1940 | @INC = grep $_ ne $self->dump_directory, @INC; |
1941 | } |
1942 | |
996be9ee |
1943 | =head2 monikers |
1944 | |
8f9d7ce5 |
1945 | Returns a hashref of loaded table to moniker mappings. There will |
996be9ee |
1946 | be two entries for each table, the original name and the "normalized" |
1947 | name, in the case that the two are different (such as databases |
1948 | that like uppercase table names, or preserve your original mixed-case |
1949 | definitions, or what-have-you). |
1950 | |
1951 | =head2 classes |
1952 | |
8f9d7ce5 |
1953 | Returns a hashref of table to class mappings. In some cases it will |
996be9ee |
1954 | contain multiple entries per table for the original and normalized table |
1955 | names, as above in L</monikers>. |
1956 | |
1957 | =head1 SEE ALSO |
1958 | |
1959 | L<DBIx::Class::Schema::Loader> |
1960 | |
be80bba7 |
1961 | =head1 AUTHOR |
1962 | |
9cc8e7e1 |
1963 | See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>. |
be80bba7 |
1964 | |
1965 | =head1 LICENSE |
1966 | |
1967 | This library is free software; you can redistribute it and/or modify it under |
1968 | the same terms as Perl itself. |
1969 | |
996be9ee |
1970 | =cut |
1971 | |
1972 | 1; |
bfb43060 |
1973 | # vim:et sts=4 sw=4 tw=0: |