MAGETWO-33814: Change parent class of Model\Exception sub-classes to Localized

- Error code eliminated in app/code and in tests;
- Added AlreadyExistsException to library;

Author: Dmytro Poperechnyy

app/code/Magento/Tax/Model/Calculation/RateRepository.php

@@ -13,7 +13,8 @@
 use Magento\Framework\Api\SearchCriteria;
 use Magento\Framework\Api\SortOrder;
 use Magento\Framework\Exception\InputException;
-use Magento\Framework\Model\Exception as ModelException;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\AlreadyExistsException;
 use Magento\Tax\Api\Data\TaxRateInterface as TaxRateDataObject;
 use Magento\Tax\Model\Calculation\Rate\Converter;
 use Magento\Tax\Model\Resource\Calculation\Rate\Collection;
@@ -104,12 +105,10 @@ public function save(\Magento\Tax\Api\Data\TaxRateInterface $taxRate)
         try {
             $this->resourceModel->save($taxRate);
             $taxRate->saveTitles($taxRateTitles);
-        } catch (ModelException $e) {
-            if ($e->getCode() == ModelException::ERROR_CODE_ENTITY_ALREADY_EXISTS) {
-                throw new InputException($e->getMessage());
-            } else {
-                throw $e;
-            }
+        } catch (AlreadyExistsException $e) {
+            throw new InputException($e->getMessage());
+        } catch (LocalizedException $e) {
+            throw $e;
         }
         $this->rateRegistry->registerTaxRate($taxRate);
         return $taxRate;

app/code/Magento/Tax/Model/TaxRuleRepository.php

@@ -9,13 +9,14 @@
 use Magento\Framework\Api\Search\FilterGroup;
 use Magento\Framework\Api\SearchCriteria;
 use Magento\Framework\Api\SortOrder;
-use Magento\Framework\Exception\CouldNotSaveException;
 use Magento\Framework\Exception\InputException;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\CouldNotSaveException;
 use Magento\Framework\Exception\NoSuchEntityException;
-use Magento\Framework\Model\Exception as ModelException;
+use Magento\Framework\Exception\AlreadyExistsException;
 use Magento\Tax\Api\Data\TaxRuleInterface;
-use Magento\Tax\Api\Data\TaxRuleSearchResultsDataBuilder;
 use Magento\Tax\Api\TaxRuleRepositoryInterface;
+use Magento\Tax\Api\Data\TaxRuleSearchResultsDataBuilder;
 use Magento\Tax\Model\Calculation\RuleFactory;
 use Magento\Tax\Model\Calculation\TaxRuleRegistry;
 use Magento\Tax\Model\Resource\Calculation\Rule as Resource;
@@ -92,14 +93,12 @@ public function save(TaxRuleInterface $rule)
                 $this->taxRuleRegistry->retrieveTaxRule($ruleId);
             }
             $this->resource->save($rule);
-        } catch (ModelException $e) {
-            if ($e->getCode() == ModelException::ERROR_CODE_ENTITY_ALREADY_EXISTS) {
-                throw new InputException($e->getMessage());
-            } else {
-                throw new CouldNotSaveException($e->getMessage());
-            }
-        } catch (NoSuchEntityException $exception) {
-            throw $exception;
+        } catch (AlreadyExistsException $e) {
+            throw new InputException($e->getMessage());
+        } catch (NoSuchEntityException $e) {
+            throw $e;
+        } catch (LocalizedException $e) {
+            throw new CouldNotSaveException($e->getMessage());
         }
         $this->taxRuleRegistry->registerTaxRule($rule);
         return $rule;

dev/tests/unit/testsuite/Magento/Tax/Model/Calculation/RateRepositoryTest.php

@@ -5,9 +5,10 @@
  */
 namespace Magento\Tax\Model\Calculation;
 
-use Magento\TestFramework\Helper\ObjectManager;
-use Magento\Framework\Model\Exception as ModelException;
 use Magento\Framework\Api\SearchCriteria;
+use Magento\TestFramework\Helper\ObjectManager;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\AlreadyExistsException;
 
 class RateRepositoryTest extends \PHPUnit_Framework_TestCase
 {
@@ -264,13 +265,13 @@ private function getTaxRateMock(array $taxRateData)
     }
 
     /**
-     * @param ModelException $expectedException
+     * @dataProvider saveThrowsExceptionIfCannotSaveTitlesDataProvider
+     * @param LocalizedException $expectedException
      * @param string $exceptionType
      * @param string $exceptionMessage
-     * @throws ModelException
+     * @throws LocalizedException
      * @throws \Exception
      * @throws \Magento\Framework\Exception\InputException
-     * @dataProvider saveThrowsExceptionIfCannotSaveTitlesDataProvider
      */
     public function testSaveThrowsExceptionIfCannotSaveTitles($expectedException, $exceptionType, $exceptionMessage)
     {
@@ -319,18 +320,13 @@ public function saveThrowsExceptionIfCannotSaveTitlesDataProvider()
     {
         return [
             'entity_already_exists' => [
-                new ModelException(
-                    'Cannot save titles',
-                    ModelException::ERROR_CODE_ENTITY_ALREADY_EXISTS
-                ),
+                new AlreadyExistsException('Entity already exists'),
                 'Magento\Framework\Exception\InputException',
-                'Cannot save titles'
+                'Entity already exists'
             ],
             'cannot_save_title' => [
-                new ModelException(
-                    'Cannot save titles'
-                ),
-                'Magento\Framework\Model\Exception',
+                new LocalizedException('Cannot save titles'),
+                'Magento\Framework\Exception\LocalizedException',
                 'Cannot save titles'
             ]
         ];

dev/tests/unit/testsuite/Magento/Tax/Model/TaxRuleRepositoryTest.php

@@ -5,7 +5,6 @@
  */
 namespace Magento\Tax\Model;
 
-use Magento\Framework\Model\Exception as ModelException;
 use Magento\Framework\Api\SearchCriteria as SearchCriteria;
 
 class TaxRuleRepositoryTest extends \PHPUnit_Framework_TestCase
@@ -118,6 +117,10 @@ public function testSave()
      * @param $exceptionObject
      * @param $exceptionName
      * @param $exceptionMessage
+     * @throws \Exception
+     * @throws \Magento\Framework\Exception\CouldNotSaveException
+     * @throws \Magento\Framework\Exception\InputException
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
      */
     public function testSaveWithExceptions($exceptionObject, $exceptionName, $exceptionMessage)
     {
@@ -137,13 +140,13 @@ public function saveExceptionsDataProvider()
     {
         return [
             [
-                new \Magento\Framework\Model\Exception('Could not save'),
+                new \Magento\Framework\Exception\LocalizedException('Could not save'),
                 '\Magento\Framework\Exception\CouldNotSaveException',
                 'Could not save'
             ], [
-                new \Magento\Framework\Model\Exception('InputError', ModelException::ERROR_CODE_ENTITY_ALREADY_EXISTS),
+                new \Magento\Framework\Exception\AlreadyExistsException('Entity already exists'),
                 '\Magento\Framework\Exception\InputException',
-                'InputError'
+                'Entity already exists'
             ], [
                 new \Magento\Framework\Exception\NoSuchEntityException('No such entity'),
                 '\Magento\Framework\Exception\NoSuchEntityException',

lib/internal/Magento/Framework/Exception/AlreadyExistsException.php

@@ -0,0 +1,11 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\Exception;
+
+class AlreadyExistsException extends \Magento\Framework\Exception\LocalizedException
+{
+}

lib/internal/Magento/Framework/Model/Resource/Db/AbstractDb.php

@@ -6,6 +6,7 @@
 
 namespace Magento\Framework\Model\Resource\Db;
 
+use Magento\Framework\Exception\AlreadyExistsException;
 use Magento\Framework\Model\Exception as ModelException;
 
 /**
@@ -596,7 +597,7 @@ protected function _prepareValueForSave($value, $type)
      *
      * @param \Magento\Framework\Model\AbstractModel $object
      * @return $this
-     * @throws ModelException
+     * @throws AlreadyExistsException
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     protected function _checkUnique(\Magento\Framework\Model\AbstractModel $object)
@@ -639,7 +640,7 @@ protected function _checkUnique(\Magento\Framework\Model\AbstractModel $object)
             } else {
                 $error = __('%1 already exist.', implode(', ', $existent));
             }
-            throw new ModelException($error, ModelException::ERROR_CODE_ENTITY_ALREADY_EXISTS);
+            throw new AlreadyExistsException($error);
         }
         return $this;
     }