Merge pull request #285 from magento-fearless-kiwis/develop

Tang, Yu(ytang1) · Tang, Yu(ytang1) · commit f852aa485dda · 2015-05-11T23:41:25.000-05:00
[FearlessKiwis] Defining public api and test coverage improvements
diff --git a/app/code/Magento/GoogleShopping/Model/Attribute/Tax.php b/app/code/Magento/GoogleShopping/Model/Attribute/Tax.php
@@ -171,9 +171,9 @@ public function convertAttribute($product, $entry)
                 foreach ($regions as $region) {
                     $adjustments = $product->getPriceInfo()->getAdjustments();
                     if (array_key_exists('tax', $adjustments)) {
-                        $taxIncluded = true;
+                        $isTaxIncluded = true;
                     } else {
-                        $taxIncluded = false;
+                        $isTaxIncluded = false;
                     }
 
                     $quoteDetailsItemDataArray = [
@@ -185,7 +185,7 @@ public function convertAttribute($product, $entry)
                         ],
                         'unit_price' => $product->getPrice(),
                         'quantity' => 1,
-                        'tax_included' => $taxIncluded,
+                        'is_tax_included' => $isTaxIncluded,
                         'short_description' => $product->getName(),
                     ];
 
diff --git a/app/code/Magento/GoogleShopping/Test/Unit/Model/Attribute/TaxTest.php b/app/code/Magento/GoogleShopping/Test/Unit/Model/Attribute/TaxTest.php
@@ -192,7 +192,7 @@ public function testConvertAttribute()
                             ],
                             'unit_price'        => $price,
                             'quantity'          => 1,
-                            'tax_included'      => 1,
+                            'is_tax_included'      => 1,
                             'short_description' => $name,
                         ],
                     ],
diff --git a/app/code/Magento/Tax/Api/Data/AppliedTaxInterface.php b/app/code/Magento/Tax/Api/Data/AppliedTaxInterface.php
@@ -5,6 +5,10 @@
  */
 namespace Magento\Tax\Api\Data;
 
+/**
+ * Applied tax interface.
+ * @api
+ */
 interface AppliedTaxInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/Data/AppliedTaxRateInterface.php b/app/code/Magento/Tax/Api/Data/AppliedTaxRateInterface.php
@@ -6,6 +6,10 @@
 
 namespace Magento\Tax\Api\Data;
 
+/**
+ * Applied tax rate interface.
+ * @api
+ */
 interface AppliedTaxRateInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/Data/QuoteDetailsInterface.php b/app/code/Magento/Tax/Api/Data/QuoteDetailsInterface.php
@@ -6,7 +6,10 @@
 
 namespace Magento\Tax\Api\Data;
 
-
+/**
+ * Quote details interface.
+ * @api
+ */
 interface QuoteDetailsInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/Data/QuoteDetailsItemInterface.php b/app/code/Magento/Tax/Api/Data/QuoteDetailsItemInterface.php
@@ -5,6 +5,10 @@
  */
 namespace Magento\Tax\Api\Data;
 
+/**
+ * Quote details item interface.
+ * @api
+ */
 interface QuoteDetailsItemInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
@@ -88,7 +92,7 @@ public function setQuantity($quantity);
      * @return bool
      * @SuppressWarnings(PHPMD.BooleanGetMethodName)
      */
-    public function getTaxIncluded();
+    public function getIsTaxIncluded();
 
     /**
      * Set whether the tax is included in the unit price and row total
diff --git a/app/code/Magento/Tax/Api/Data/TaxClassInterface.php b/app/code/Magento/Tax/Api/Data/TaxClassInterface.php
@@ -7,6 +7,10 @@
 
 namespace Magento\Tax\Api\Data;
 
+/**
+ * Tax class interface.
+ * @api
+ */
 interface TaxClassInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/Data/TaxClassKeyInterface.php b/app/code/Magento/Tax/Api/Data/TaxClassKeyInterface.php
@@ -8,6 +8,10 @@
 
 use Magento\Framework\Api\ExtensibleDataInterface;
 
+/**
+ * Tax class key interface.
+ * @api
+ */
 interface TaxClassKeyInterface extends ExtensibleDataInterface
 {
     /**#@+
diff --git a/app/code/Magento/Tax/Api/Data/TaxClassSearchResultsInterface.php b/app/code/Magento/Tax/Api/Data/TaxClassSearchResultsInterface.php
@@ -6,6 +6,10 @@
 
 namespace Magento\Tax\Api\Data;
 
+/**
+ * Interface for tax class search results.
+ * @api
+ */
 interface TaxClassSearchResultsInterface extends \Magento\Framework\Api\SearchResultsInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/Data/TaxDetailsInterface.php b/app/code/Magento/Tax/Api/Data/TaxDetailsInterface.php
@@ -6,6 +6,10 @@
 
 namespace Magento\Tax\Api\Data;
 
+/**
+ * Tax details interface.
+ * @api
+ */
 interface TaxDetailsInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/Data/TaxDetailsItemInterface.php b/app/code/Magento/Tax/Api/Data/TaxDetailsItemInterface.php
@@ -6,6 +6,10 @@
 
 namespace Magento\Tax\Api\Data;
 
+/**
+ * Tax details items interface.
+ * @api
+ */
 interface TaxDetailsItemInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/Data/TaxRateInterface.php b/app/code/Magento/Tax/Api/Data/TaxRateInterface.php
@@ -7,6 +7,10 @@
 
 namespace Magento\Tax\Api\Data;
 
+/**
+ * Tax rate interface.
+ * @api
+ */
 interface TaxRateInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/Data/TaxRateSearchResultsInterface.php b/app/code/Magento/Tax/Api/Data/TaxRateSearchResultsInterface.php
@@ -9,6 +9,10 @@
 
 use Magento\Framework\Api\SearchResultsInterface;
 
+/**
+ * Interface for tax rate search results.
+ * @api
+ */
 interface TaxRateSearchResultsInterface extends SearchResultsInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/Data/TaxRateTitleInterface.php b/app/code/Magento/Tax/Api/Data/TaxRateTitleInterface.php
@@ -7,6 +7,10 @@
 
 namespace Magento\Tax\Api\Data;
 
+/**
+ * Tax rate title interface.
+ * @api
+ */
 interface TaxRateTitleInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/Data/TaxRuleInterface.php b/app/code/Magento/Tax/Api/Data/TaxRuleInterface.php
@@ -8,6 +8,10 @@
 
 use Magento\Framework\Api\ExtensibleDataInterface;
 
+/**
+ * Tax rule interface.
+ * @api
+ */
 interface TaxRuleInterface extends ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/Data/TaxRuleSearchResultsInterface.php b/app/code/Magento/Tax/Api/Data/TaxRuleSearchResultsInterface.php
@@ -6,6 +6,10 @@
 
 namespace Magento\Tax\Api\Data;
 
+/**
+ * Interface for tax rule search results.
+ * @api
+ */
 interface TaxRuleSearchResultsInterface extends \Magento\Framework\Api\SearchResultsInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/TaxCalculationInterface.php b/app/code/Magento/Tax/Api/TaxCalculationInterface.php
@@ -6,6 +6,10 @@
 
 namespace Magento\Tax\Api;
 
+/**
+ * Tax calculation interface.
+ * @api
+ */
 interface TaxCalculationInterface
 {
     /**#@+
diff --git a/app/code/Magento/Tax/Api/TaxClassManagementInterface.php b/app/code/Magento/Tax/Api/TaxClassManagementInterface.php
@@ -7,6 +7,10 @@
 
 namespace Magento\Tax\Api;
 
+/**
+ * Interface for managing classes rates.
+ * @api
+ */
 interface TaxClassManagementInterface
 {
     /**#@+
diff --git a/app/code/Magento/Tax/Api/TaxClassRepositoryInterface.php b/app/code/Magento/Tax/Api/TaxClassRepositoryInterface.php
@@ -7,6 +7,10 @@
 
 namespace Magento\Tax\Api;
 
+/**
+ * Tax class CRUD interface.
+ * @api
+ */
 interface TaxClassRepositoryInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/TaxRateManagementInterface.php b/app/code/Magento/Tax/Api/TaxRateManagementInterface.php
@@ -8,6 +8,10 @@
 
 use Magento\Tax\Api\Data\TaxRateInterface;
 
+/**
+ * Interface for managing tax rates.
+ * @api
+ */
 interface TaxRateManagementInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/TaxRateRepositoryInterface.php b/app/code/Magento/Tax/Api/TaxRateRepositoryInterface.php
@@ -7,6 +7,10 @@
 
 namespace Magento\Tax\Api;
 
+/**
+ * Tax rate CRUD interface.
+ * @api
+ */
 interface TaxRateRepositoryInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Api/TaxRuleRepositoryInterface.php b/app/code/Magento/Tax/Api/TaxRuleRepositoryInterface.php
@@ -6,6 +6,10 @@
 
 namespace Magento\Tax\Api;
 
+/**
+ * Tax rule CRUD interface.
+ * @api
+ */
 interface TaxRuleRepositoryInterface
 {
     /**
diff --git a/app/code/Magento/Tax/Controller/Adminhtml/Tax.php b/app/code/Magento/Tax/Controller/Adminhtml/Tax.php
@@ -49,7 +49,7 @@ public function __construct(
      */
     protected function _processClassName($className)
     {
-        $className = trim($this->_objectManager->get('Magento\Framework\Escaper')->escapeHtml($className));
+        $className = trim($className);
         if ($className == '') {
             throw new InputException(__('Invalid name of tax class specified.'));
         }
diff --git a/app/code/Magento/Tax/Model/Calculation/AbstractCalculator.php b/app/code/Magento/Tax/Model/Calculation/AbstractCalculator.php
@@ -217,7 +217,7 @@ public function setCustomerId($customerId)
      */
     public function calculate(QuoteDetailsItemInterface $item, $quantity, $round = true)
     {
-        if ($item->getTaxIncluded()) {
+        if ($item->getIsTaxIncluded()) {
             return $this->calculateWithTaxInPrice($item, $quantity, $round);
         } else {
             return $this->calculateWithTaxNotInPrice($item, $quantity, $round);
diff --git a/app/code/Magento/Tax/Model/Converter.php b/app/code/Magento/Tax/Model/Converter.php
diff --git a/app/code/Magento/Tax/Model/Sales/Quote/ItemDetails.php b/app/code/Magento/Tax/Model/Sales/Quote/ItemDetails.php
@@ -21,7 +21,7 @@ class ItemDetails extends AbstractExtensibleModel implements QuoteDetailsItemInt
     const KEY_TAX_CLASS_KEY        = 'tax_class_key';
     const KEY_UNIT_PRICE           = 'unit_price';
     const KEY_QUANTITY             = 'quantity';
-    const KEY_TAX_INCLUDED         = 'tax_included';
+    const KEY_IS_TAX_INCLUDED      = 'is_tax_included';
     const KEY_SHORT_DESCRIPTION    = 'short_description';
     const KEY_DISCOUNT_AMOUNT      = 'discount_amount';
     const KEY_PARENT_CODE          = 'parent_code';
@@ -72,9 +72,9 @@ public function getQuantity()
     /**
      * {@inheritdoc}
      */
-    public function getTaxIncluded()
+    public function getIsTaxIncluded()
     {
-        return $this->getData(self::KEY_TAX_INCLUDED);
+        return $this->getData(self::KEY_IS_TAX_INCLUDED);
     }
 
     /**
@@ -180,7 +180,7 @@ public function setQuantity($quantity)
      */
     public function setIsTaxIncluded($isTaxIncluded)
     {
-        return $this->setData(self::KEY_TAX_INCLUDED, $isTaxIncluded);
+        return $this->setData(self::KEY_IS_TAX_INCLUDED, $isTaxIncluded);
     }
 
     /**
diff --git a/app/code/Magento/Tax/Test/Unit/GetterSetterTest.php b/app/code/Magento/Tax/Test/Unit/GetterSetterTest.php
diff --git a/app/code/Magento/Tax/Test/Unit/Model/Calculation/RowBaseAndTotalBaseCalculatorTestCase.php b/app/code/Magento/Tax/Test/Unit/Model/Calculation/RowBaseAndTotalBaseCalculatorTestCase.php
diff --git a/app/code/Magento/Tax/Test/Unit/Model/Calculation/UnitBaseCalculatorTest.php b/app/code/Magento/Tax/Test/Unit/Model/Calculation/UnitBaseCalculatorTest.php
diff --git a/app/code/Magento/Tax/Test/Unit/Model/Sales/Total/Quote/TaxTest.php b/app/code/Magento/Tax/Test/Unit/Model/Sales/Total/Quote/TaxTest.php
diff --git a/app/code/Magento/Tax/Test/Unit/Model/TaxClass/Source/CustomerTest.php b/app/code/Magento/Tax/Test/Unit/Model/TaxClass/Source/CustomerTest.php
diff --git a/app/code/Magento/Tax/Test/Unit/Model/TaxClass/Source/ProductTest.php b/app/code/Magento/Tax/Test/Unit/Model/TaxClass/Source/ProductTest.php
diff --git a/dev/tests/integration/testsuite/Magento/Tax/Controller/Adminhtml/TaxTest.php b/dev/tests/integration/testsuite/Magento/Tax/Controller/Adminhtml/TaxTest.php
diff --git a/dev/tests/integration/testsuite/Magento/Tax/Model/TaxCalculationTest.php b/dev/tests/integration/testsuite/Magento/Tax/Model/TaxCalculationTest.php
diff --git a/lib/web/mage/backend/editablemultiselect.js b/lib/web/mage/backend/editablemultiselect.js

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,10 @@`
`6`	`6`
`7`	`7`	`namespace Magento\Tax\Api\Data;`
`8`	`8`
	`9`	`+/**`
	`10`	`+ * Applied tax rate interface.`
	`11`	`+ * @api`
	`12`	`+ */`
`9`	`13`	`interface AppliedTaxRateInterface extends \Magento\Framework\Api\ExtensibleDataInterface`
`10`	`14`	`{`
`11`	`15`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,10 @@`
`7`	`7`
`8`	`8`	`namespace Magento\Tax\Api\Data;`
`9`	`9`
	`10`	`+/**`
	`11`	`+ * Tax class interface.`
	`12`	`+ * @api`
	`13`	`+ */`
`10`	`14`	`interface TaxClassInterface extends \Magento\Framework\Api\ExtensibleDataInterface`
`11`	`15`	`{`
`12`	`16`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,10 @@`
`8`	`8`
`9`	`9`	`use Magento\Framework\Api\ExtensibleDataInterface;`
`10`	`10`
	`11`	`+/**`
	`12`	`+ * Tax class key interface.`
	`13`	`+ * @api`
	`14`	`+ */`
`11`	`15`	`interface TaxClassKeyInterface extends ExtensibleDataInterface`
`12`	`16`	`{`
`13`	`17`	`/**#@+`