MAGETWO-55657: Implement new service OrderInvoice

NadiyaS · NadiyaS · commit dab08ab23c2f · 2016-08-02T15:25:54.000+03:00
- rename exception classes
 - fix statics
diff --git a/app/code/Magento/Sales/Api/CouldNotInvoiceException.php b/app/code/Magento/Sales/Api/CouldNotInvoiceException.php
@@ -4,13 +4,15 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sales\Model\Order;
+namespace Magento\Sales\Api;
 
 use Magento\Framework\Exception\LocalizedException;
 
 /**
- * Class SalesOperationFailedException
+ * Class CouldNotInvoiceException
+ * @api
  */
-class SalesOperationFailedException extends LocalizedException
+class CouldNotInvoiceException extends LocalizedException
 {
+
 }
diff --git a/app/code/Magento/Sales/Api/Data/InvoiceCommentCreationInterface.php b/app/code/Magento/Sales/Api/Data/InvoiceCommentCreationInterface.php
@@ -8,6 +8,8 @@
 
 /**
  * Interface InvoiceCommentCreationInterface
+ *
+ * @api
  */
 interface InvoiceCommentCreationInterface extends \Magento\Sales\Api\Data\CommentInterface
 {
diff --git a/app/code/Magento/Sales/Api/Data/InvoiceCommentInterface.php b/app/code/Magento/Sales/Api/Data/InvoiceCommentInterface.php
@@ -13,7 +13,7 @@
  * @api
  */
 interface InvoiceCommentInterface extends
-\Magento\Framework\Api\ExtensibleDataInterface, \Magento\Sales\Api\Data\InvoiceCommentCreationInterface
+    \Magento\Framework\Api\ExtensibleDataInterface, \Magento\Sales\Api\Data\InvoiceCommentCreationInterface
 {
     /**#@+
      * Constants for keys of data array. Identical to the name of the getter in snake case.
diff --git a/app/code/Magento/Sales/Api/Data/InvoiceInterface.php b/app/code/Magento/Sales/Api/Data/InvoiceInterface.php
@@ -201,15 +201,6 @@ interface InvoiceInterface extends \Magento\Framework\Api\ExtensibleDataInterfac
      */
     const COMMENTS = 'comments';
 
-    /**
-     * Invoice states
-     */
-    const STATE_OPEN = 1;
-
-    const STATE_PAID = 2;
-
-    const STATE_CANCELED = 3;
-
     /**
      * Gets the base currency code for the invoice.
      *
diff --git a/app/code/Magento/Sales/Api/Data/InvoiceItemCreationInterface.php b/app/code/Magento/Sales/Api/Data/InvoiceItemCreationInterface.php
@@ -10,6 +10,8 @@
  * Input argument for invoice creation
  *
  * Interface InvoiceItemCreationInterface
+ *
+ * @api
  */
 interface InvoiceItemCreationInterface extends LineItemInterface
 {
diff --git a/app/code/Magento/Sales/Api/Data/InvoiceItemInterface.php b/app/code/Magento/Sales/Api/Data/InvoiceItemInterface.php
@@ -113,10 +113,12 @@ interface InvoiceItemInterface extends \Magento\Sales\Api\Data\InvoiceItemCreati
      * Base discount tax compensation amount.
      */
     const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount';
+
     /**
      * Invoice
      */
     const INVOICE = 'invoice';
+
     /**
      * Gets the additional data for the invoice item.
      *
diff --git a/app/code/Magento/Sales/Api/DocumentValidationException.php b/app/code/Magento/Sales/Api/DocumentValidationException.php
@@ -4,13 +4,14 @@
  * See COPYING.txt for license details.
  */
 
-namespace Magento\Sales\Model\Order;
+namespace Magento\Sales\Api;
 
 use Magento\Framework\Exception\LocalizedException;
 
 /**
- * Class SalesDocumentValidationException
+ * Class DocumentValidationException
+ * @api
  */
-class SalesDocumentValidationException extends LocalizedException
+class DocumentValidationException extends LocalizedException
 {
 }
diff --git a/app/code/Magento/Sales/Api/OrderInvoiceInterface.php b/app/code/Magento/Sales/Api/OrderInvoiceInterface.php
@@ -8,7 +8,6 @@
 
 /**
  * Class OrderInvoiceInterface
- *  Should be part of OrderManagementInterface::invoice()
  *
  * @api
  */
diff --git a/app/code/Magento/Sales/Model/Order/Invoice.php b/app/code/Magento/Sales/Model/Order/Invoice.php
@@ -22,6 +22,16 @@
  */
 class Invoice extends AbstractModel implements EntityInterface, InvoiceInterface
 {
+    /**#@+
+     * Invoice states
+     */
+    const STATE_OPEN = 1;
+
+    const STATE_PAID = 2;
+
+    const STATE_CANCELED = 3;
+    /**#@-*/
+
     const CAPTURE_ONLINE = 'online';
 
     const CAPTURE_OFFLINE = 'offline';
diff --git a/app/code/Magento/Sales/Model/Order/Invoice/NotifierInterface.php b/app/code/Magento/Sales/Model/Order/Invoice/NotifierInterface.php
@@ -3,6 +3,7 @@
  * Copyright © 2016 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Sales\Model\Order\Invoice;
 
 /**
diff --git a/app/code/Magento/Sales/Model/Order/InvoiceDocumentFactory.php b/app/code/Magento/Sales/Model/Order/InvoiceDocumentFactory.php
@@ -39,7 +39,7 @@ public function __construct(
      * @param OrderInterface $order
      * @param array $items
      * @param InvoiceCommentCreationInterface|null $comment
-     * @param bool $appendComment
+     * @param bool|false $appendComment
      * @param InvoiceCreationArgumentsInterface|null $arguments
      * @return InvoiceInterface
      */
diff --git a/app/code/Magento/Sales/Model/Order/InvoiceValidator.php b/app/code/Magento/Sales/Model/Order/InvoiceValidator.php
@@ -69,7 +69,8 @@ private function checkQtyAvailability(InvoiceInterface $invoice, OrderInterface
             foreach ($order->getItems() as $orderItem) {
                 if (isset($qtys[$orderItem->getId()])) {
                     if ($qtys[$orderItem->getId()] > $orderItem->getQtyToInvoice() && !$orderItem->isDummy()) {
-                        $messages[] = __('The quantity to invoice must not be greater than the uninvoiced quantity'
+                        $messages[] = __(
+                            'The quantity to invoice must not be greater than the uninvoiced quantity'
                                 . ' for product SKU "%1".',
                             $orderItem->getSku()
                         );
diff --git a/app/code/Magento/Sales/Model/OrderInvoice.php b/app/code/Magento/Sales/Model/OrderInvoice.php
@@ -1,9 +1,9 @@
 <?php
-
 /**
  * Copyright © 2016 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Sales\Model;
 
 use Magento\Sales\Api\Data\InvoiceCommentCreationInterface;
@@ -19,12 +19,13 @@
 use Magento\Sales\Model\Order\Config as OrderConfig;
 use Magento\Sales\Api\Data\InvoiceInterface;
 use Magento\Sales\Model\Order\InvoiceRepository;
-use Magento\Sales\Model\Order\SalesDocumentValidationException;
-use Magento\Sales\Model\Order\SalesOperationFailedException;
+use Magento\Sales\Api\DocumentValidationException;
+use Magento\Sales\Api\CouldNotInvoiceException;
 use Psr\Log\LoggerInterface;
 
 /**
  * Class InvoiceService
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class OrderInvoice implements OrderInvoiceInterface
 {
@@ -90,6 +91,7 @@ class OrderInvoice implements OrderInvoiceInterface
      * @param InvoiceRepository $invoiceRepository
      * @param NotifierInterface $notifierInterface
      * @param LoggerInterface $logger
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         ResourceConnection $resourceConnection,
@@ -123,9 +125,9 @@ public function __construct(
      * @param bool $appendComment
      * @param \Magento\Sales\Api\Data\InvoiceCommentCreationInterface|null $comment
      * @param \Magento\Sales\Api\Data\InvoiceCreationArgumentsInterface|null $arguments
-     * @return int|null
-     * @throws \Magento\Sales\Model\Order\SalesDocumentValidationException
-     * @throws \Magento\Sales\Model\Order\SalesOperationFailedException
+     * @return int
+     * @throws DocumentValidationException
+     * @throws CouldNotInvoiceException
      * @throws \Magento\Framework\Exception\InputException
      * @throws \Magento\Framework\Exception\NoSuchEntityException
      * @throws \DomainException
@@ -150,7 +152,9 @@ public function execute(
         );
         $errorMessages = $this->invoiceValidator->validate($invoice, $order);
         if (!empty($errorMessages)) {
-            throw new SalesDocumentValidationException(__("Sales Document Validation Error", $errorMessages));
+            throw new DocumentValidationException(__(
+                "Invoice Document Validation Error(s):\n" . implode("\n", $errorMessages))
+            );
         }
         $connection->beginTransaction();
         try {
@@ -166,7 +170,7 @@ public function execute(
         } catch (\Exception $e) {
             $this->logger->critical($e);
             $connection->rollBack();
-            throw new SalesOperationFailedException(__("Sales Operation Failed", $e->getMessage()));
+            throw new CouldNotInvoiceException(__('Could not save an invoice, see error log for details'));
         }
         if ($notify) {
             if (!$appendComment) {
diff --git a/app/code/Magento/Sales/Test/Unit/Model/Order/Invoice/PayOperationTest.php b/app/code/Magento/Sales/Test/Unit/Model/Order/Invoice/PayOperationTest.php
@@ -53,7 +53,7 @@ class PayOperationTest extends \PHPUnit_Framework_TestCase
     protected function setUp()
     {
         $this->orderMock = $this->getMockForAbstractClass(
-            'Magento\Sales\Api\Data\OrderInterface',
+            \Magento\Sales\Api\Data\OrderInterface::class,
             [],
             '',
             false,
@@ -140,7 +140,7 @@ protected function setUp()
             ->willReturn(31);
 
         $this->invoiceMock = $this->getMockForAbstractClass(
-            'Magento\Sales\Api\Data\InvoiceInterface',
+            \Magento\Sales\Api\Data\InvoiceInterface::class,
             [],
             '',
             false,
@@ -216,15 +216,15 @@ protected function setUp()
             ->willReturn(31);
 
         $this->contextMock = $this->getMock(
-            'Magento\Framework\Model\Context',
+            \Magento\Framework\Model\Context::class,
             [],
             [],
             '',
             false
         );
 
         $this->invoiceItemMock = $this->getMockForAbstractClass(
-            'Magento\Sales\Api\Data\InvoiceItemInterface',
+            \Magento\Sales\Api\Data\InvoiceItemInterface::class,
             [],
             '',
             false,
@@ -243,7 +243,7 @@ protected function setUp()
             ->willReturn(1);
 
         $this->orderPaymentMock = $this->getMockForAbstractClass(
-            'Magento\Sales\Api\Data\OrderPaymentInterface',
+            \Magento\Sales\Api\Data\OrderPaymentInterface::class,
             [],
             '',
             false,
@@ -260,7 +260,7 @@ protected function setUp()
             ->willReturn($this->orderPaymentMock);
 
         $this->eventManagerMock = $this->getMockForAbstractClass(
-            'Magento\Framework\Event\ManagerInterface',
+            \Magento\Framework\Event\ManagerInterface::class,
             [],
             '',
             false,
@@ -273,7 +273,7 @@ protected function setUp()
             ->willReturn($this->eventManagerMock);
 
         $this->paymentMethodMock = $this->getMockForAbstractClass(
-            'Magento\Payment\Model\MethodInterface',
+            \Magento\Payment\Model\MethodInterface::class,
             [],
             '',
             false,
diff --git a/app/code/Magento/Sales/Test/Unit/Model/Order/Invoice/Sender/EmailSenderTest.php b/app/code/Magento/Sales/Test/Unit/Model/Order/Invoice/Sender/EmailSenderTest.php
diff --git a/app/code/Magento/Sales/Test/Unit/Model/Order/InvoiceDocumentFactoryTest.php b/app/code/Magento/Sales/Test/Unit/Model/Order/InvoiceDocumentFactoryTest.php
diff --git a/app/code/Magento/Sales/Test/Unit/Model/Order/InvoiceValidatorTest.php b/app/code/Magento/Sales/Test/Unit/Model/Order/InvoiceValidatorTest.php
diff --git a/app/code/Magento/Sales/Test/Unit/Model/Order/OrderValidatorTest.php b/app/code/Magento/Sales/Test/Unit/Model/Order/OrderValidatorTest.php
diff --git a/app/code/Magento/Sales/Test/Unit/Model/Order/PaymentAdapterTest.php b/app/code/Magento/Sales/Test/Unit/Model/Order/PaymentAdapterTest.php
diff --git a/app/code/Magento/Sales/Test/Unit/Model/Order/StateResolverTest.php b/app/code/Magento/Sales/Test/Unit/Model/Order/StateResolverTest.php
diff --git a/app/code/Magento/Sales/Test/Unit/Model/OrderInvoiceTest.php b/app/code/Magento/Sales/Test/Unit/Model/OrderInvoiceTest.php

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* Interface InvoiceCommentCreationInterface`
	`11`	`+ *`
	`12`	`+ * @api`
`11`	`13`	`*/`
`12`	`14`	`interface InvoiceCommentCreationInterface extends \Magento\Sales\Api\Data\CommentInterface`
`13`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`* @api`
`14`	`14`	`*/`
`15`	`15`	`interface InvoiceCommentInterface extends`
`16`		`-\Magento\Framework\Api\ExtensibleDataInterface, \Magento\Sales\Api\Data\InvoiceCommentCreationInterface`
	`16`	`+ \Magento\Framework\Api\ExtensibleDataInterface, \Magento\Sales\Api\Data\InvoiceCommentCreationInterface`
`17`	`17`	`{`
`18`	`18`	`/**#@+`
`19`	`19`	`* Constants for keys of data array. Identical to the name of the getter in snake case.`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`	`* Input argument for invoice creation`
`11`	`11`	`*`
`12`	`12`	`* Interface InvoiceItemCreationInterface`
	`13`	`+ *`
	`14`	`+ * @api`
`13`	`15`	`*/`
`14`	`16`	`interface InvoiceItemCreationInterface extends LineItemInterface`
`15`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,6 @@`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* Class OrderInvoiceInterface`
`11`		`- * Should be part of OrderManagementInterface::invoice()`
`12`	`11`	`*`
`13`	`12`	`* @api`
`14`	`13`	`*/`