use Digest::MD5 qw(md5_hex);
use English qw( -no_match_vars );
use Getopt::Long;
-use List::MoreUtils qw(any);
+use List::MoreUtils qw(none);
+use List::UtilsBy qw(partition_by);
use Pod::Usage;
+use Rose::DB::Object 0.809;
use Term::ANSIColor;
use SL::Auth;
$OUTPUT_AUTOFLUSH = 1;
$Data::Dumper::Sortkeys = 1;
-our $meta_path = "SL/DB/MetaSetup";
+our $meta_path = "SL/DB/MetaSetup";
+our $manager_path = "SL/DB/Manager";
my %config;
-our %foreign_key_name_map = (
- oe => { payment => 'payment_terms', },
- ar => { payment => 'payment_terms', },
- ap => { payment => 'payment_terms', },
-
- orderitems => { parts => 'part', trans => 'order', },
- delivery_order_items => { parts => 'part' },
- invoice => { parts => 'part' },
-
- periodic_invoices_configs => { oe => 'order' },
+# Maps column names in tables to foreign key relationship names. For
+# example:
+#
+# »follow_up_access« contains a column named »who«. Rose normally
+# names the resulting relationship after the class the target table
+# uses. In this case the target table is »employee« and the
+# corresponding class SL::DB::Employee. The resulting relationship
+# would be named »employee«.
+#
+# In order to rename this relationship we have to map »who« to
+# e.g. »granted_by«:
+# follow_up_access => { who => 'granted_by' },
+
+our %foreign_key_name_map = (
+ KIVITENDO => {
+ oe => { payment_id => 'payment_terms', },
+ ar => { payment_id => 'payment_terms', },
+ ap => { payment_id => 'payment_terms', },
+
+ orderitems => { parts_id => 'part', trans_id => 'order', },
+ delivery_order_items => { parts_id => 'part' },
+ invoice => { parts_id => 'part' },
+ follow_ups => { created_for_user => 'created_for', created_by => 'created_by', },
+ follow_up_access => { who => 'with_access', what => 'to_follow_ups_by', },
+
+ periodic_invoices_configs => { oe_id => 'order' },
+ },
);
sub setup {
usage();
}
- mkdir $meta_path unless -d $meta_path;
+ foreach (($meta_path, $manager_path)) {
+ mkdir $_ unless -d;
+ }
+}
+
+sub fix_relationship_names {
+ my ($domain, $table, $fkey_text) = @_;
+
+ if ($fkey_text !~ m/key_columns \s+ => \s+ \{ \s+ ['"]? ( [^'"\s]+ ) /x) {
+ die "fix_relationship_names: could not extract the key column for domain/table $domain/$table; foreign key definition text:\n${fkey_text}\n";
+ }
+
+ my $column_name = $1;
+ my %changes = map { %{$_} } grep { $_ } ($foreign_key_name_map{$domain}->{ALL}, $foreign_key_name_map{$domain}->{$table});
+
+ if (my $desired_name = $changes{$column_name}) {
+ $fkey_text =~ s/^ \s\s [^\s]+ \b/ ${desired_name}/msx;
+ }
+
+ return $fkey_text;
}
sub process_table {
- my @spec = split(/=/, shift, 2);
- my $table = $spec[0];
+ my ($domain, $table, $package) = @_;
my $schema = '';
($schema, $table) = split(m/\./, $table) if $table =~ m/\./;
- my $package = ucfirst($spec[1] || $spec[0]);
+ $package = ucfirst($package || $table);
$package =~ s/_+(.)/uc($1)/ge;
my $meta_file = "${meta_path}/${package}.pm";
+ my $mngr_file = "${manager_path}/${package}.pm";
my $file = "SL/DB/${package}.pm";
my $schema_str = $schema ? <<CODE : '';
my %args = (indent => 2, use_setup => 0);
my $definition = "SL::DB::AUTO::$package"->meta->perl_class_definition(%args);
- $definition =~ s/(__PACKAGE__->meta->initialize;)/# $1/;
+ $definition =~ s/\n+__PACKAGE__->meta->initialize;\n+/\n\n/;
$definition =~ s/::AUTO::/::/g;
+
+ # Sort column definitions alphabetically
+ if ($definition =~ m/__PACKAGE__->meta->columns\( \n (.+?) \n \);/msx) {
+ my ($start, $end) = ($-[1], $+[1]);
+ my $sorted_columns = join "\n", sort split m/\n/, $1;
+ substr $definition, $start, $end - $start, $sorted_columns;
+ }
+
# patch foreign keys
my $foreign_key_definition = "SL::DB::AUTO::$package"->meta->perl_foreign_keys_definition(%args);
+ $foreign_key_definition =~ s/::AUTO::/::/g;
- if ($definition =~ /\Q$foreign_key_definition\E/) {
+ if ($foreign_key_definition && ($definition =~ /\Q$foreign_key_definition\E/)) {
+ # These positions refer to the whole setup call, not just the
+ # parameters/actual relationship definitions.
my ($start, $end) = ($-[0], $+[0]);
- while (my ($auto_generated_name, $desired_name) = each %{ $foreign_key_name_map{$table} || {} }) {
- $foreign_key_definition =~ s/^ \s \s ${auto_generated_name} \b/ ${desired_name}/msx;
- }
+ # Match the function parameters = the actual relationship
+ # definitions
+ next unless $foreign_key_definition =~ m/\(\n(.+)\n\)/s;
+
+ my ($list_start, $list_end) = ($-[0], $+[0]);
+
+ # Split the whole chunk on double new lines. The resulting
+ # elements are one relationship each. Then fix the relationship
+ # names and sort them by their new names.
+ my @new_foreign_keys = sort map { fix_relationship_names($domain, $table, $_) } split m/\n\n/m, $1;
+
+ # Replace the function parameters = the actual relationship
+ # definitions with the new ones.
+ my $sorted_foreign_keys = "(\n" . join("\n\n", @new_foreign_keys) . "\n)";
+ substr $foreign_key_definition, $list_start, $list_end - $list_start, $sorted_foreign_keys;
- substr($definition, $start, $end - $start) = $foreign_key_definition;
+ # Replace the whole setup call in the auto-generated output with
+ # our new version.
+ substr $definition, $start, $end - $start, $foreign_key_definition;
}
$definition =~ s/(meta->table.*)\n/$1\n$schema_str/m if $schema;
use strict;
use SL::DB::MetaSetup::${package};
+use SL::DB::Manager::${package};
__PACKAGE__->meta->initialize;
-# Creates get_all, get_all_count, get_all_iterator, delete_all and update_all.
-__PACKAGE__->meta->make_manager_class;
-
1;
CODE
my $old_md5 = md5_hex($orig_file);
my $new_size = length $full_definition;
my $new_md5 = md5_hex($full_definition);
- if ($old_size == $new_size && $old_md5 == $new_md5) {
+ if ($old_size == $new_size && $old_md5 eq $new_md5) {
notice("No changes in $meta_file, skipping.") unless $config{quiet};
return;
}
notice("File '$meta_file' " . ($file_exists ? 'updated' : 'created') . " for table '$table'");
- if (! -f $file) {
- if (!$config{nocommit}) {
- open my $out, ">", $file || die;
- print $out $meta_definition;
- }
+ return if -f $file;
+
+ if (!$config{nocommit}) {
+ open my $out, ">", $file || die;
+ print $out $meta_definition;
+ }
+
+ notice("File '$file' created as well.");
+
+ return if -f $mngr_file;
+
+ if (!$config{nocommit}) {
+ open my $out, ">", $mngr_file || die;
+ print $out <<EOT;
+# This file has been auto-generated only because it didn't exist.
+# Feel free to modify it at will; it will not be overwritten automatically.
+
+package SL::DB::Manager::${package};
+
+use strict;
+
+use SL::DB::Helper::Manager;
+use base qw(SL::DB::Helper::Manager);
+
+sub object_class { 'SL::DB::${package}' }
- notice("File '$file' created as well.");
+__PACKAGE__->make_manager_methods;
+
+1;
+EOT
}
+
+ notice("File '$mngr_file' created as well.");
}
sub parse_args {
GetOptions(
'client=s' => \ my $client,
all => \ my $all,
+ 'db=s' => \ my $db,
'no-commit|dry-run' => \ my $nocommit,
help => sub { pod2usage(verbose => 99, sections => 'NAME|SYNOPSIS|OPTIONS') },
quiet => \ my $quiet,
diff => \ my $diff,
- 'color!' => \ my $color,
);
$options->{client} = $client;
$options->{all} = $all;
+ $options->{db} = $db;
$options->{nocommit} = $nocommit;
$options->{quiet} = $quiet;
- $options->{color} = defined $color ? $color : 1;
+ $options->{color} = -t STDOUT ? 1 : 0;
if ($diff) {
if (eval { require Text::Diff; 1 }) {
}
sub make_tables {
- my @tables;
+ my %tables_by_domain;
if ($config{all}) {
- my $db = SL::DB::create(undef, 'KIVITENDO');
- @tables =
- map { $package_names{KIVITENDO}->{$_} ? "$_=" . $package_names{KIVITENDO}->{$_} : $_ }
- grep { my $table = $_; !any { $_ eq $table } @{ $blacklist{KIVITENDO} } }
- $db->list_tables;
+ my @domains = $config{db} ? (uc $config{db}) : sort keys %package_names;
+
+ foreach my $domain (@domains) {
+ my $db = SL::DB::create(undef, $domain);
+ $tables_by_domain{$domain} = [ grep { my $table = $_; none { $_ eq $table } @{ $blacklist{$domain} } } $db->list_tables ];
+ $db->disconnect;
+ }
+
} elsif (@ARGV) {
- @tables = @ARGV;
+ %tables_by_domain = partition_by {
+ my ($domain, $table) = split m{:};
+ $table ? uc($domain) : 'KIVITENDO';
+ } @ARGV;
+
+ foreach my $tables (values %tables_by_domain) {
+ s{.*:}{} for @{ $tables };
+ }
+
} else {
error("You specified neither --all nor any specific tables.");
usage();
}
- @tables;
+ return %tables_by_domain;
}
sub error {
print @_, $/;
}
+sub check_errors_in_package_names {
+ foreach my $domain (sort keys %package_names) {
+ my @both = grep { $package_names{$domain}->{$_} } @{ $blacklist{$domain} || [] };
+ next unless @both;
+
+ print "Error: domain '$domain': The following table names are present in both the black list and the package name hash: ", join(' ', sort @both), "\n";
+ exit 1;
+ }
+}
+
parse_args(\%config);
setup();
-my @tables = make_tables();
+check_errors_in_package_names();
-for my $table (@tables) {
- # add default model name unless model name is given or no defaults exists
- $table .= '=' . $package_names{KIVITENDO}->{lc $table} if $table !~ /=/ && $package_names{KIVITENDO}->{lc $table};
+my %tables_by_domain = make_tables();
- process_table($table);
+foreach my $domain (keys %tables_by_domain) {
+ my @tables = @{ $tables_by_domain{$domain} };
+ my @unknown_tables = grep { !$package_names{$domain}->{$_} } @tables;
+ if (@unknown_tables) {
+ error("The following tables do not have entries in \%SL::DB::Helper::Mappings::${domain}_package_names: " . join(' ', sort @unknown_tables));
+ exit 1;
+ }
+
+ process_table($domain, $_, $package_names{$domain}->{$_}) for @tables;
}
1;
=head1 SYNOPSIS
- scripts/rose_create_model.pl --client name-or-id table1[=package1] [table2[=package2] ...]
- scripts/rose_create_model.pl --client name-or-id [--all|-a]
+ scripts/rose_auto_create_model.pl --client name-or-id [db1:]table1 [[db2:]table2 ...]
+ scripts/rose_auto_create_model.pl --client name-or-id [--all|-a]
# updates all models
- scripts/rose_create_model.pl --client name-or-id --all
+ scripts/rose_auto_create_model.pl --client name-or-id --all [--db db]
# updates only customer table, login taken from config
- scripts/rose_create_model.pl customer
+ scripts/rose_auto_create_model.pl customer
# updates only parts table, package will be Part
- scripts/rose_create_model.pl parts=Part
+ scripts/rose_auto_create_model.pl parts=Part
# try to update parts, but don't do it. tell what would happen in detail
- scripts/rose_create_model.pl --no-commit parts
+ scripts/rose_auto_create_model.pl --no-commit parts
=head1 DESCRIPTION
load the schema information for this table and create the appropriate class
files, or update them if already present.
-Each table has two associated files. A C<SL::DB::MetaSetup::*> class, which is
-a perl version of the schema definition, and a C<SL::DB::*> class file. The
-first one will be updated if the schema changes, the second one will only be
-created if it does not exist.
+Each table has three associated files. A C<SL::DB::MetaSetup::*>
+class, which is a perl version of the schema definition, a
+C<SL::DB::*> class file and a C<SL::DB::Manager::*> manager class
+file. The first one will be updated if the schema changes, the second
+and third ones will only be created if it they do not exist.
+
+=head1 DATABASE NAMES AND TABLES
+
+If you want to generate the data for specific tables only then you
+have to list them on the command line. The format is
+C<db-name:table-name>. The part C<db-name:> is optional and defaults
+to C<KIVITENDO:> – which means the tables in the default kivitendo
+database.
+
+Valid database names are keys in the hash returned by
+L<SL::DB::Helper::Mappings/get_package_names>.
=head1 OPTIONS
Process all tables from the database. Only those that are blacklistes in
L<SL::DB::Helper::Mappings> are excluded.
+=item C<--db db>
+
+In combination with C<--all> causes all tables in the specific
+database to be processed, not in all databases.
+
=item C<--no-commit, -n>
=item C<--dry-run>
=head1 AUTHOR
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
=cut
projects / kivitendo-erp.git / blobdiff