SL/Dev/Record.pm

   1 package SL::Dev::Record;
   2
   3 use strict;
   4 use base qw(Exporter);
   5 our @EXPORT_OK = qw(create_invoice_item create_sales_invoice create_credit_note create_order_item  create_sales_order create_purchase_order create_delivery_order_item create_sales_delivery_order create_purchase_delivery_order create_project create_department);
   6 our %EXPORT_TAGS = (ALL => \@EXPORT_OK);
   7
   8 use SL::DB::Invoice;
   9 use SL::DB::InvoiceItem;
  10 use SL::DB::Employee;
  11 use SL::Dev::Part qw(new_part);
  12 use SL::Dev::CustomerVendor qw(new_vendor new_customer);
  13 use SL::DB::Project;
  14 use SL::DB::ProjectStatus;
  15 use SL::DB::ProjectType;
  16 use DateTime;
  17
  18 my %record_type_to_item_type = ( sales_invoice        => 'SL::DB::InvoiceItem',
  19                                  credit_note          => 'SL::DB::InvoiceItem',
  20                                  sales_order          => 'SL::DB::OrderItem',
  21                                  purchase_order       => 'SL::DB::OrderItem',
  22                                  sales_delivery_order => 'SL::DB::DeliveryOrderItem',
  23                                );
  24
  25 sub create_sales_invoice {
  26   my (%params) = @_;
  27
  28   my $record_type = 'sales_invoice';
  29   my $invoiceitems = delete $params{invoiceitems} // _create_two_items($record_type);
  30   _check_items($invoiceitems, $record_type);
  31
  32   my $customer = delete $params{customer} // new_customer(name => 'Testcustomer')->save;
  33   die "illegal customer" unless defined $customer && ref($customer) eq 'SL::DB::Customer';
  34
  35   my $invoice = SL::DB::Invoice->new(
  36     invoice      => 1,
  37     type         => 'invoice',
  38     customer_id  => $customer->id,
  39     taxzone_id   => $customer->taxzone->id,
  40     invnumber    => delete $params{invnumber}   // undef,
  41     currency_id  => $params{currency_id} // $::instance_conf->get_currency_id,
  42     taxincluded  => $params{taxincluded} // 0,
  43     employee_id  => $params{employee_id} // SL::DB::Manager::Employee->current->id,
  44     salesman_id  => $params{employee_id} // SL::DB::Manager::Employee->current->id,
  45     transdate    => $params{transdate}   // DateTime->today_local->to_kivitendo,
  46     payment_id   => $params{payment_id}  // undef,
  47     gldate       => DateTime->today,
  48     invoiceitems => $invoiceitems,
  49   );
  50   $invoice->assign_attributes(%params) if %params;
  51
  52   $invoice->post;
  53   return $invoice;
  54 }
  55
  56 sub create_credit_note {
  57   my (%params) = @_;
  58
  59   my $record_type = 'credit_note';
  60   my $invoiceitems = delete $params{invoiceitems} // _create_two_items($record_type);
  61   _check_items($invoiceitems, $record_type);
  62
  63   my $customer = delete $params{customer} // new_customer(name => 'Testcustomer')->save;
  64   die "illegal customer" unless defined $customer && ref($customer) eq 'SL::DB::Customer';
  65
  66   # adjust qty for credit note items
  67   $_->qty( $_->qty * -1) foreach @{$invoiceitems};
  68
  69   my $invoice = SL::DB::Invoice->new(
  70     invoice      => 1,
  71     type         => 'credit_note',
  72     customer_id  => $customer->id,
  73     taxzone_id   => $customer->taxzone->id,
  74     invnumber    => delete $params{invnumber}   // undef,
  75     currency_id  => $params{currency_id} // $::instance_conf->get_currency_id,
  76     taxincluded  => $params{taxincluded} // 0,
  77     employee_id  => $params{employee_id} // SL::DB::Manager::Employee->current->id,
  78     salesman_id  => $params{employee_id} // SL::DB::Manager::Employee->current->id,
  79     transdate    => $params{transdate}   // DateTime->today_local->to_kivitendo,
  80     payment_id   => $params{payment_id}  // undef,
  81     gldate       => DateTime->today,
  82     invoiceitems => $invoiceitems,
  83   );
  84   $invoice->assign_attributes(%params) if %params;
  85
  86   $invoice->post;
  87   return $invoice;
  88 }
  89
  90 sub create_sales_delivery_order {
  91   my (%params) = @_;
  92
  93   my $record_type = 'sales_delivery_order';
  94   my $orderitems = delete $params{orderitems} // _create_two_items($record_type);
  95   _check_items($orderitems, $record_type);
  96
  97   my $customer = $params{customer} // new_customer(name => 'Testcustomer')->save;
  98   die "illegal customer" unless ref($customer) eq 'SL::DB::Customer';
  99
 100   my $delivery_order = SL::DB::DeliveryOrder->new(
 101     'is_sales'   => 'true',
 102     'closed'     => undef,
 103     customer_id  => $customer->id,
 104     taxzone_id   => $customer->taxzone_id,
 105     donumber     => $params{donumber}    // undef,
 106     currency_id  => $params{currency_id} // $::instance_conf->get_currency_id,
 107     taxincluded  => $params{taxincluded} // 0,
 108     employee_id  => $params{employee_id} // SL::DB::Manager::Employee->current->id,
 109     salesman_id  => $params{employee_id} // SL::DB::Manager::Employee->current->id,
 110     transdate    => $params{transdate}   // DateTime->today,
 111     orderitems   => $orderitems,
 112   );
 113   $delivery_order->assign_attributes(%params) if %params;
 114   $delivery_order->save;
 115   return $delivery_order;
 116 }
 117
 118 sub create_purchase_delivery_order {
 119   my (%params) = @_;
 120
 121   my $record_type = 'purchase_delivery_order';
 122   my $orderitems = delete $params{orderitems} // _create_two_items($record_type);
 123   _check_items($orderitems, $record_type);
 124
 125   my $vendor = $params{vendor} // new_vendor(name => 'Testvendor')->save;
 126   die "illegal customer" unless ref($vendor) eq 'SL::DB::Vendor';
 127
 128   my $delivery_order = SL::DB::DeliveryOrder->new(
 129     'is_sales'   => 'false',
 130     'closed'     => undef,
 131     vendor_id    => $vendor->id,
 132     taxzone_id   => $vendor->taxzone_id,
 133     donumber     => $params{donumber}    // undef,
 134     currency_id  => $params{currency_id} // $::instance_conf->get_currency_id,
 135     taxincluded  => $params{taxincluded} // 0,
 136     employee_id  => $params{employee_id} // SL::DB::Manager::Employee->current->id,
 137     salesman_id  => $params{employee_id} // SL::DB::Manager::Employee->current->id,
 138     transdate    => $params{transdate}   // DateTime->today,
 139     orderitems   => $orderitems,
 140   );
 141   $delivery_order->assign_attributes(%params) if %params;
 142   $delivery_order->save;
 143   return $delivery_order;
 144 }
 145
 146 sub create_sales_order {
 147   my (%params) = @_;
 148
 149   my $record_type = 'sales_order';
 150   my $orderitems = delete $params{orderitems} // _create_two_items($record_type);
 151   _check_items($orderitems, $record_type);
 152
 153   my $save = delete $params{save} // 0;
 154
 155   my $customer = $params{customer} // new_customer(name => 'Testcustomer')->save;
 156   die "illegal customer" unless ref($customer) eq 'SL::DB::Customer';
 157
 158   my $order = SL::DB::Order->new(
 159     customer_id  => delete $params{customer_id} // $customer->id,
 160     taxzone_id   => delete $params{taxzone_id}  // $customer->taxzone->id,
 161     currency_id  => delete $params{currency_id} // $::instance_conf->get_currency_id,
 162     taxincluded  => delete $params{taxincluded} // 0,
 163     employee_id  => delete $params{employee_id} // SL::DB::Manager::Employee->current->id,
 164     salesman_id  => delete $params{employee_id} // SL::DB::Manager::Employee->current->id,
 165     transdate    => delete $params{transdate}   // DateTime->today,
 166     orderitems   => $orderitems,
 167   );
 168   $order->assign_attributes(%params) if %params;
 169
 170   if ( $save ) {
 171     $order->calculate_prices_and_taxes;
 172     $order->save;
 173   }
 174   return $order;
 175 }
 176
 177 sub create_purchase_order {
 178   my (%params) = @_;
 179
 180   my $record_type = 'purchase_order';
 181   my $orderitems = delete $params{orderitems} // _create_two_items($record_type);
 182   _check_items($orderitems, $record_type);
 183
 184   my $save = delete $params{save} // 0;
 185
 186   my $vendor = $params{vendor} // new_vendor(name => 'Testvendor')->save;
 187   die "illegal vendor" unless ref($vendor) eq 'SL::DB::Vendor';
 188
 189   my $order = SL::DB::Order->new(
 190     vendor_id    => delete $params{vendor_id}   // $vendor->id,
 191     taxzone_id   => delete $params{taxzone_id}  // $vendor->taxzone->id,
 192     currency_id  => delete $params{currency_id} // $::instance_conf->get_currency_id,
 193     taxincluded  => delete $params{taxincluded} // 0,
 194     transdate    => delete $params{transdate}   // DateTime->today,
 195     'closed'     => undef,
 196     orderitems   => $orderitems,
 197   );
 198   $order->assign_attributes(%params) if %params;
 199
 200   if ( $save ) {
 201     $order->calculate_prices_and_taxes; # not tested for purchase orders
 202     $order->save;
 203   }
 204   return $order;
 205 };
 206
 207 sub _check_items {
 208   my ($items, $record_type) = @_;
 209
 210   if  ( scalar @{$items} == 0 or grep { ref($_) ne $record_type_to_item_type{"$record_type"} } @{$items} ) {
 211     die "Error: items must be an arrayref of " . $record_type_to_item_type{"$record_type"} . "objects.";
 212   }
 213 }
 214
 215 sub create_invoice_item {
 216   my (%params) = @_;
 217
 218   return _create_item(record_type => 'sales_invoice', %params);
 219 }
 220
 221 sub create_order_item {
 222   my (%params) = @_;
 223
 224   return _create_item(record_type => 'sales_order', %params);
 225 }
 226
 227 sub create_delivery_order_item {
 228   my (%params) = @_;
 229
 230   return _create_item(record_type => 'sales_delivery_order', %params);
 231 }
 232
 233 sub _create_item {
 234   my (%params) = @_;
 235
 236   my $record_type = delete($params{record_type});
 237   my $part        = delete($params{part});
 238
 239   die "illegal record type: $record_type, must be one of: " . join(' ', keys %record_type_to_item_type) unless $record_type_to_item_type{ $record_type };
 240   die "part missing as param" unless $part && ref($part) eq 'SL::DB::Part';
 241
 242   my ($sellprice, $lastcost);
 243
 244   if ( $record_type =~ /^sales/ ) {
 245     $sellprice = delete $params{sellprice} // $part->sellprice;
 246     $lastcost  = delete $params{lastcost}  // $part->lastcost;
 247   } else {
 248     $sellprice = delete $params{sellprice} // $part->lastcost;
 249     $lastcost  = delete $params{lastcost}  // 0; # $part->lastcost;
 250   }
 251
 252   my $item = "$record_type_to_item_type{$record_type}"->new(
 253     parts_id    => $part->id,
 254     sellprice   => $sellprice,
 255     lastcost    => $lastcost,
 256     description => $part->description,
 257     unit        => $part->unit,
 258     qty         => $params{qty} || 5,
 259   );
 260   $item->assign_attributes(%params) if %params;
 261   return $item;
 262 }
 263
 264 sub _create_two_items {
 265   my ($record_type) = @_;
 266
 267   my $part1 = new_part(description => 'Testpart 1',
 268                        sellprice   => 12,
 269                       )->save;
 270   my $part2 = new_part(description => 'Testpart 2',
 271                        sellprice   => 10,
 272                       )->save;
 273   my $item1 = _create_item(record_type => $record_type, part => $part1, qty => 5);
 274   my $item2 = _create_item(record_type => $record_type, part => $part2, qty => 8);
 275   return [ $item1, $item2 ];
 276 }
 277
 278 sub create_project {
 279   my (%params) = @_;
 280   my $project = SL::DB::Project->new(
 281     projectnumber     => delete $params{projectnumber} // 1,
 282     description       => delete $params{description} // "Test project",
 283     active            => 1,
 284     valid             => 1,
 285     project_status_id => SL::DB::Manager::ProjectStatus->find_by(name => "running")->id,
 286     project_type_id   => SL::DB::Manager::ProjectType->find_by(description => "Standard")->id,
 287   )->save;
 288   $project->assign_attributes(%params) if %params;
 289   return $project;
 290 }
 291
 292 sub create_department {
 293   my (%params) = @_;
 294
 295   my $department = SL::DB::Department->new(
 296     'description' => delete $params{description} // 'Test Department',
 297   )->save;
 298
 299   $department->assign_attributes(%params) if %params;
 300   return $department;
 301
 302 }
 303 1;
 304
 305 __END__
 306
 307 =head1 NAME
 308
 309 SL::Dev::Record - create record objects for testing, with minimal defaults
 310
 311 =head1 FUNCTIONS
 312
 313 =head2 C<create_sales_invoice %PARAMS>
 314
 315 Creates a new sales invoice (table ar, invoice = 1).
 316
 317 If neither customer nor invoiceitems are passed as params a customer and two
 318 parts are created and used for building the invoice.
 319
 320 Minimal usage example:
 321
 322   my $invoice = SL::Dev::Record::create_sales_invoice();
 323
 324 Example with params:
 325
 326   my $invoice2 = SL::Dev::Record::create_sales_invoice(
 327     invnumber   => 777,
 328     transdate   => DateTime->today->subtract(days => 7),
 329     taxincluded => 1,
 330   );
 331
 332 =head2 C<create_credit_note %PARAMS>
 333
 334 Create a credit note (sales). Use positive quantities when adding items.
 335
 336 Example including creation of parts and of credit_note:
 337
 338   my $part1 = SL::Dev::Part::new_part(   partnumber => 'T4254')->save;
 339   my $part2 = SL::Dev::Part::new_service(partnumber => 'Serv1')->save;
 340   my $credit_note = SL::Dev::Record::create_credit_note(
 341     invnumber    => '34',
 342     taxincluded  => 0,
 343     invoiceitems => [ SL::Dev::Record::create_invoice_item(part => $part1, qty =>  3, sellprice => 70),
 344                       SL::Dev::Record::create_invoice_item(part => $part2, qty => 10, sellprice => 50),
 345                     ]
 346   );
 347
 348 =head2 C<create_sales_order %PARAMS>
 349
 350 Examples:
 351
 352 Create a sales order and save it directly via rose, without running
 353 calculate_prices_and_taxes:
 354
 355   my $order = SL::Dev::Record::create_sales_order()->save;
 356
 357 Let create_sales_order run calculate_prices_and_taxes and save:
 358
 359   my $order = SL::Dev::Record::create_sales_order(save => 1);
 360
 361
 362 Example including creation of part and of sales order:
 363
 364   my $part1 = SL::Dev::Part::new_part(   partnumber => 'T4254')->save;
 365   my $part2 = SL::Dev::Part::new_service(partnumber => 'Serv1')->save;
 366   my $order = SL::Dev::Record::create_sales_order(
 367     save         => 1,
 368     taxincluded  => 0,
 369     orderitems => [ SL::Dev::Record::create_order_item(part => $part1, qty =>  3, sellprice => 70),
 370                     SL::Dev::Record::create_order_item(part => $part2, qty => 10, sellprice => 50),
 371                   ]
 372   );
 373
 374 Example: create 100 orders with the same part for 100 new customers:
 375
 376   my $part1 = SL::Dev::Part::new_part(partnumber => 'T6256')->save;
 377   SL::Dev::Record::create_sales_order(
 378     save         => 1,
 379     taxincluded  => 0,
 380     orderitems => [ SL::Dev::Record::create_order_item(part => $part1, qty => 1, sellprice => 9) ]
 381   ) for 1 .. 100;
 382
 383 =head2 C<create_purchase_order %PARAMS>
 384
 385 See comments for C<create_sales_order>.
 386
 387 Example:
 388
 389   my $purchase_order = SL::Dev::Record::create_purchase_order(save => 1);
 390
 391
 392 =head2 C<create_item %PARAMS>
 393
 394 Creates an item from a part object that can be added to a record.
 395
 396 Required params:
 397
 398   record_type (sales_invoice, sales_order, sales_delivery_order)
 399   part        (an SL::DB::Part object)
 400
 401 Example including creation of part and of invoice:
 402
 403   my $part    = SL::Dev::Part::new_part(  partnumber  => 'T4254')->save;
 404   my $item    = SL::Dev::Record::create_invoice_item(part => $part, qty => 2.5);
 405   my $invoice = SL::Dev::Record::create_sales_invoice(
 406     taxincluded  => 0,
 407     invoiceitems => [ $item ],
 408   );
 409
 410 =head2 C<create_project %PARAMS>
 411
 412 Creates a default project.
 413
 414 Minimal example, creating a project with status "running" and type "Standard":
 415
 416   my $project = SL::Dev::Record::create_project();
 417
 418   $project = SL::Dev::Record::create_project(
 419     projectnumber => 'p1',
 420     description   => 'Test project',
 421   )
 422
 423 If C<$params{description}> or C<$params{projectnumber}> exists, this will override the
 424 default value 'Test project'.
 425
 426 C<%params> should only contain alterable keys from the object Project.
 427
 428 =head2 C<create_department %PARAMS>
 429
 430 Creates a default department.
 431
 432 Minimal example:
 433
 434   my $department = SL::Dev::Record::create_department();
 435
 436   my $department = SL::Dev::Record::create_department(
 437     description => 'Hawaii',
 438   )
 439
 440 If C<$params{description}> exists, this will override the
 441 default value 'Test Department'.
 442
 443 C<%params> should only contain alterable keys from the object Department.
 444
 445
 446 =head1 BUGS
 447
 448 Nothing here yet.
 449
 450 =head1 AUTHOR
 451
 452 G. Richardson E<lt>grichardson@kivitendo-premium.deE<gt>
 453
 454 =cut