SL/DB/Helper/Mappings.pm

   1 package SL::DB::Helper::Mappings;
   2
   3 use utf8;
   4 use strict;
   5
   6 require Exporter;
   7 our @ISA       = qw(Exporter);
   8 our @EXPORT_OK = qw(get_table_for_package get_package_for_table get_package_names);
   9
  10 # these will not be managed as Rose::DB models, because they are not normalized,
  11 # significant changes are needed to get them done, or they were done by CRM.
  12 my @lxoffice_blacklist_permanent = qw(
  13   leads
  14 );
  15
  16 # these are not managed _yet_, but will hopefully at some point.
  17 # if you are confident that one of these works, remove it here.
  18 my @lxoffice_blacklist_temp = qw(
  19 );
  20
  21 # tables created by crm module
  22 my @crm_blacklist = qw(
  23 );
  24
  25 # tables created by cash register
  26 my @cash_register_blacklist = qw(
  27 ekartikel ekbon ekkunde ektext erptasten
  28 );
  29
  30 my @lxoffice_blacklist = (@lxoffice_blacklist_permanent, @lxoffice_blacklist_temp, @crm_blacklist, @cash_register_blacklist);
  31
  32 # map table names to their models.
  33 # unlike rails we have no singular<->plural magic.
  34 # remeber: tables should be named as the plural of the model name.
  35 my %lxoffice_package_names = (
  36   acc_trans                      => 'acc_transaction',
  37   audittrail                     => 'audit_trail',
  38   auth_group                     => 'auth_groups',
  39   auth_group_right               => 'auth_group_rights',
  40   auth_user                      => 'auth_users',
  41   auth_user_config               => 'auth_user_configs',
  42   auth_user_group                => 'auth_user_groups',
  43   ar                             => 'invoice',
  44   ap                             => 'purchase_invoice',
  45   background_jobs                => 'background_job',
  46   background_job_histories       => 'background_job_history',
  47   ap                             => 'purchase_invoice',
  48   bank_accounts                  => 'bank_account',
  49   buchungsgruppen                => 'buchungsgruppe',
  50   contacts                       => 'contact',
  51   csv_import_profiles            => 'csv_import_profile',
  52   csv_import_profile_settings    => 'csv_import_profile_setting',
  53   custom_variable_configs        => 'custom_variable_config',
  54   custom_variables               => 'custom_variable',
  55   custom_variables_validity      => 'custom_variable_validity',
  56   customertax                    => 'customer_tax',
  57   datev                          => 'datev',
  58   defaults                       => 'default',
  59   delivery_orders                => 'delivery_order',
  60   delivery_order_items           => 'delivery_order_item',
  61   department                     => 'department',
  62   dpt_trans                      => 'dpt_trans',
  63   drafts                         => 'draft',
  64   dunning                        => 'dunning',
  65   dunning_config                 => 'dunning_config',
  66   employee                       => 'employee',
  67   exchangerate                   => 'exchangerate',
  68   finanzamt                      => 'finanzamt',
  69   follow_up_access               => 'follow_up_access',
  70   follow_up_links                => 'follow_up_link',
  71   follow_ups                     => 'follow_up',
  72   generic_translations           => 'generic_translation',
  73   gifi                           => 'gifi',
  74   gl                             => 'GLTransaction',
  75   history_erp                    => 'history',
  76   inventory                      => 'inventory',
  77   invoice                        => 'invoice_item',
  78   language                       => 'language',
  79   makemodel                      => 'make_model',
  80   notes                          => 'note',
  81   orderitems                     => 'order_item',
  82   oe                             => 'order',
  83   parts                          => 'part',
  84   partsgroup                     => 'parts_group',
  85   partstax                       => 'parts_tax',
  86   payment_terms                  => 'payment_term',
  87   periodic_invoices              => 'periodic_invoice',
  88   periodic_invoices_configs      => 'periodic_invoices_config',
  89   prices                         => 'price',
  90   price_factors                  => 'price_factor',
  91   pricegroup                     => 'pricegroup',
  92   printers                       => 'Printer',
  93   record_links                   => 'record_link',
  94   rma                            => 'RMA',
  95   rmaitems                       => 'RMA_item',
  96   sepa_export                    => 'sepa_export',
  97   sepa_export_items              => 'sepa_export_item',
  98   schema_info                    => 'schema_info',
  99   status                         => 'status',
 100   tax                            => 'tax',
 101   taxkeys                        => 'tax_key',
 102   tax_zones                      => 'tax_zone',
 103   todo_user_config               => 'todo_user_config',
 104   translation                    => 'translation',
 105   translation_payment_terms      => 'translation_payment_term',
 106   units                          => 'unit',
 107   units_language                 => 'units_language',
 108   vendortax                      => 'vendor_tax',
 109 );
 110
 111 my (%lxoffice_tables_to_packages, %lxoffice_tables_to_manager_packages, %lxoffice_packages_to_tables);
 112
 113 sub get_blacklist {
 114   return LXOFFICE => \@lxoffice_blacklist;
 115 }
 116
 117 sub get_package_names {
 118   return LXOFFICE => \%lxoffice_package_names;
 119 }
 120
 121 sub get_package_for_table {
 122   %lxoffice_tables_to_packages = map { ($_ => "SL::DB::" . camelify($lxoffice_package_names{$_})) } keys %lxoffice_package_names
 123     unless %lxoffice_tables_to_packages;
 124
 125   return $lxoffice_tables_to_packages{ $_[0] };
 126 }
 127
 128 sub get_manager_package_for_table {
 129   %lxoffice_tables_to_manager_packages = map { ($_ => "SL::DB::Manager::" . camelify($lxoffice_package_names{$_})) } keys %lxoffice_package_names
 130     unless %lxoffice_tables_to_manager_packages;
 131
 132   return $lxoffice_tables_to_manager_packages{ $_[0] };
 133 }
 134
 135 sub get_table_for_package {
 136   get_package_for_table('dummy') if !%lxoffice_tables_to_packages;
 137   %lxoffice_packages_to_tables = reverse %lxoffice_tables_to_packages unless %lxoffice_packages_to_tables;
 138
 139   my $package = $_[0] =~ m/^SL::DB::/ ? $_[0] : "SL::DB::" . $_[0];
 140   return $lxoffice_packages_to_tables{ $package };
 141 }
 142
 143 sub db {
 144   my $string = $_[0];
 145   my $lookup = $lxoffice_package_names{$_[0]} ||
 146       plurify($lxoffice_package_names{singlify($_[0])});
 147
 148   for my $thing ($string, $lookup) {
 149
 150     # best guess? its already the name. like part. camelize it first
 151     my $class = "SL::DB::" . camelify($thing);
 152     return $class if defined *{ $class. '::' };
 153
 154     # next, someone wants a manager and pluralized.
 155     my $manager = "SL::DB::Manager::" . singlify(camelify($thing));
 156     return $manager if defined *{ $manager . '::' };
 157   }
 158
 159   die "Can't resolve '$string' as a database model, sorry. Did you perhaps forgot to load it?";
 160 }
 161
 162 sub camelify {
 163   my ($str) = @_;
 164   $str =~ s/_+(.)/uc($1)/ge;
 165   ucfirst $str;
 166 }
 167
 168 sub snakify {
 169   my ($str) = @_;
 170   $str =~ s/(?<!^)\u(.)/'_' . lc($1)/ge;
 171   lcfirst $str;
 172 }
 173
 174 sub plurify {
 175   my ($str) = @_;
 176   $str . 's';
 177 }
 178
 179 sub singlify {
 180   my ($str) = @_;
 181   local $/ = 's';
 182   chomp $str;
 183   $str;
 184 }
 185
 186 1;
 187
 188 __END__
 189
 190 =encoding utf8
 191
 192 =head1 NAME
 193
 194 SL::DB::Helper::Mappings - Rose Table <-> Model mapping information
 195
 196 =head1 SYNOPSIS
 197
 198   use SL::DB::Helper::Mappings qw(@blacklist %table2model);
 199
 200 =head1 DESCRIPTION
 201
 202 This modul stores table <-> model mappings used by the
 203 L<scripts/rose_auto_create_model.pl> script.  If you add a new table that has
 204 custom mappings, add it here.
 205
 206 =head1 FUNCTIONS
 207
 208 =over 4
 209
 210 =item C<db $name>
 211
 212 A special function provided here is C<db>. Without it you'd have to write:
 213
 214   my $part = SL::DB::Part->new(id => 1234);
 215   my @all_parts = SL::DB::Manager::Part->get_all;
 216
 217 with them it becomes:
 218
 219   my $part = db('part')->new(id => 123);
 220   my @all_parts = db('parts')->get_all;
 221
 222 You don't have to care about add that SL::DB:: incantation anymore. Also, a
 223 simple s at the end will get you the associated Manager class.
 224
 225 db is written to try to make sense of what you give it, but if all fails, it
 226 will die with an error.
 227
 228 =item C<get_package_for_table $table_name>
 229
 230 Returns the package name for a table name:
 231
 232   SL::DB::Helper::Mappings::get_package_for_table('oe')
 233   # SL::DB::Order
 234
 235 =item C<get_manager_package_for_table $table_name>
 236
 237 Returns the manager package name for a table name:
 238
 239   SL::DB::Helper::Mappings::get_manager_package_for_table('oe')
 240   # SL::DB::Manager::Order
 241
 242 =item C<get_table_for_package $package_name>
 243
 244 Returns the table name for a package name:
 245
 246   SL::DB::Helper::Mappings::get_table_for_package('SL::DB::Order')
 247   # oe
 248   SL::DB::Helper::Mappings::get_table_for_package('Order')
 249   # oe
 250
 251 =back
 252
 253 =head1 BUGS
 254
 255 nothing yet
 256
 257 =head1 SEE ALSO
 258
 259 L<scripts/rose_auto_create_model.pl>
 260
 261 =head1 AUTHOR
 262
 263 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>,
 264 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
 265
 266 =cut