SL/Dev/Record.pm

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