From 155b8aa4f756d7cd34a2b26a65207cbacce40ec3 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Sven=20Sch=C3=B6ling?= <sven.schoeling@opendynamic.de>
Date: Wed, 20 Nov 2019 14:07:02 +0100
Subject: [PATCH] Inventory: Parameter oe_id in for_object_id umbenannt und
 besser dokumentiert

---
 SL/Helper/Inventory.pm | 26 +++++++++++++++-----------
 t/wh/inventory.t       |  2 +-
 2 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/SL/Helper/Inventory.pm b/SL/Helper/Inventory.pm
index bb163ade2..14d4d1619 100644
--- a/SL/Helper/Inventory.pm
+++ b/SL/Helper/Inventory.pm
@@ -209,7 +209,7 @@ sub allocate {
         bestbefore        => $chunk->{bestbefore},
         reserve_for_id    => $chunk->{reserve_for_id},
         reserve_for_table => $chunk->{reserve_for_table},
-        oe_id             => undef,
+        for_object_id     => undef,
       );
       $rest_qty -=  _round_qty($qty);
     }
@@ -323,7 +323,7 @@ sub produce_assembly {
   my $bin          = $params{bin} or Carp::croak("need target bin");
   my $chargenumber = $params{chargenumber};
   my $bestbefore   = $params{bestbefore};
-  my $oe_id        = $params{oe_id};
+  my $for_object_id = $params{for_object_id};
   my $comment      = $params{comment} // '';
 
   my $production_order_item = $params{production_order_item};
@@ -354,6 +354,7 @@ sub produce_assembly {
 
   my @transfers;
   for my $allocation (@$allocations) {
+    my $oe_id = delete $allocation->{for_object_id};
     push @transfers, SL::DB::Inventory->new(
       trans_id     => $trans_id,
       %$allocation,
@@ -361,7 +362,7 @@ sub produce_assembly {
       trans_type   => $trans_type_out,
       shippingdate => $shippingdate,
       employee     => SL::DB::Manager::Employee->current,
-      oe_id        => $allocation->oe_id,
+      oe_id        => $allocation->for_object_id,
     );
   }
 
@@ -382,7 +383,7 @@ sub produce_assembly {
     comment           => $comment,
     prod              => $production_order_item,
     employee          => SL::DB::Manager::Employee->current,
-    oe_id             => $oe_id,
+    oe_id             => $for_object_id,
   );
 
   SL::DB->client->with_transaction(sub {
@@ -396,7 +397,7 @@ sub produce_assembly {
 }
 
 package SL::Helper::Inventory::Allocation {
-  my @attributes = qw(parts_id qty bin_id warehouse_id chargenumber bestbefore comment reserve_for_id reserve_for_table oe_id);
+  my @attributes = qw(parts_id qty bin_id warehouse_id chargenumber bestbefore comment reserve_for_id reserve_for_table for_object_id);
   my %attributes = map { $_ => 1 } @attributes;
 
   for my $name (@attributes) {
@@ -478,7 +479,7 @@ SL::WH - Warehouse and Inventory API
     bestbefore        => undef,
     reserve_for_id    => undef,
     reserve_for_table => undef,
-    oe_id             => $my_document,
+    for_object_id     => $order->id,
   );
 
   # produce_assembly:
@@ -766,15 +767,18 @@ each of the following attributes to be set at creation time:
 
 =item * reserve_for_table
 
-=item * oe_id
+=item * for_object_id
 
-Must be explicit set if the allocation needs also an (other) document.
+If set the allocations will be marked as allocated for the given object.
+If these allocations are later used to produce an assembly, the resulting
+consuming transactions will be marked as belonging to the given object.
+The object may be an order, productionorder or other objects
 
 =back
 
-C<chargenumber>, C<bestbefore>, C<reserve_for_id>, C<reserve_for_table> and oe_id  may
-be C<undef> (but must still be present at creation time). Instances are
-considered immutable.
+C<chargenumber>, C<bestbefore>, C<reserve_for_id>, C<reserve_for_table> and
+C<for_object_id> may be C<undef> (but must still be present at creation time).
+Instances are considered immutable.
 
 
 =head1 CONSTRAINTS
diff --git a/t/wh/inventory.t b/t/wh/inventory.t
index c209436f5..36fc73ba1 100644
--- a/t/wh/inventory.t
+++ b/t/wh/inventory.t
@@ -89,7 +89,7 @@ is_deeply(\%{ $allocations[0] }, {
    reserve_for_table => undef,
    warehouse_id      => $wh->id,
    comment           => undef,
-   oe_id             => undef,
+   for_object_id     => undef,
  }, 'allocation works');
 
 # simple
-- 
2.20.1