MAGETWO-65420: Update reports definitions for the Advanced Reporting service

Author: fascinosum

app/code/Magento/Analytics/ReportXml/DB/ColumnsResolver.php

@@ -6,7 +6,7 @@
 
 namespace Magento\Analytics\ReportXml\DB;
 
-use Magento\Framework\DB\Sql\JsonSerializableExpression;
+use Magento\Framework\DB\Sql\ColumnValueExpression;
 
 /**
  * Class ColumnsResolver
@@ -53,7 +53,7 @@ public function getColumns(SelectBuilder $selectBuilder, $entityConfig)
                 if (isset($attributeData['distinct']) && $attributeData['distinct'] == true) {
                     $prefix = ' DISTINCT ';
                 }
-                $expression = new JsonSerializableExpression(
+                $expression = new ColumnValueExpression(
                     strtoupper($attributeData['function']) . '(' . $prefix . $tableAlias . '.' . $columnName . ')'
                 );
             } else {

app/code/Magento/Analytics/ReportXml/DB/ConditionResolver.php

@@ -7,6 +7,7 @@
 namespace Magento\Analytics\ReportXml\DB;
 
 use Magento\Framework\App\ResourceConnection;
+use Magento\Framework\DB\Sql\MagentoDbExpression;
 
 /**
  * Class ConditionResolver
@@ -87,7 +88,7 @@ private function getValue($condition, $referencedEntity)
                 $value = $this->getConnection()->quote($argument);
                 break;
             case "variable":
-                $value = new \Zend_Db_Expr($argument);
+                $value = new MagentoDbExpression($argument);
                 break;
             case "identifier":
                 $value = $this->getConnection()->quoteIdentifier(
@@ -110,7 +111,9 @@ private function getValue($condition, $referencedEntity)
     private function getCondition(SelectBuilder $selectBuilder, $tableName, $condition, $referencedEntity = null)
     {
         $columns = $selectBuilder->getColumns();
-        if (isset($columns[$condition['attribute']]) && $columns[$condition['attribute']] instanceof \Zend_Db_Expr) {
+        if (isset($columns[$condition['attribute']])
+            && $columns[$condition['attribute']] instanceof MagentoDbExpression
+        ) {
             $expression = $columns[$condition['attribute']];
         } else {
             $expression = $tableName . '.' . $condition['attribute'];

app/code/Magento/Analytics/Test/Unit/ReportXml/DB/ColumnsResolverTest.php

@@ -8,7 +8,7 @@
 use Magento\Analytics\ReportXml\DB\NameResolver;
 use Magento\Analytics\ReportXml\DB\ColumnsResolver;
 use Magento\Analytics\ReportXml\DB\SelectBuilder;
-use Magento\Framework\DB\Sql\JsonSerializableExpression;
+use Magento\Framework\DB\Sql\ColumnValueExpression;
 
 /**
  * Class ColumnsResolverTest
@@ -57,7 +57,7 @@ public function testGetColumnsWithoutAttributes()
     public function testGetColumns($expression, $attributeData)
     {
         $columnAlias = 'fn';
-        $expr = new JsonSerializableExpression($expression);
+        $expr = new ColumnValueExpression($expression);
         $expectedResult = [$columnAlias => $expr];
         $columns = [$columnAlias => 'name'];
         $entityConfig['attribute'] = ['attribute1' => $attributeData];

app/code/Magento/Analytics/Test/Unit/ReportXml/DB/ConditionResolverTest.php

@@ -9,6 +9,7 @@
 use Magento\Framework\App\ResourceConnection;
 use Magento\Analytics\ReportXml\DB\SelectBuilder;
 use Magento\Framework\DB\Adapter\AdapterInterface;
+use Magento\Framework\DB\Sql\MagentoDbExpression;
 
 /**
  * Class ConditionResolverTest
@@ -80,7 +81,7 @@ public function testGetFilter()
 
         $this->selectBuilderMock->expects($this->any())
             ->method('getColumns')
-            ->willReturn(['price' => new \Zend_Db_Expr("(n.price = 400)")]);
+            ->willReturn(['price' => new MagentoDbExpression("(n.price = 400)")]);
 
         $this->resourceConnectionMock->expects($this->once())
             ->method('getConnection')

lib/internal/Magento/Framework/DB/Sql/ColumnValueExpression.php

@@ -5,15 +5,12 @@
  */
 namespace Magento\Framework\DB\Sql;
 
-use Magento\Framework\App\ResourceConnection;
-use Magento\Framework\DB\Adapter\AdapterInterface;
-
 /**
  * Class Column Value Expression
  *
- * Just a wrapper over Zend_Db_Expr to eliminate direct dependency on it
+ * Just a wrapper over MagentoDbExpression for implementing the specific type of expression.
  * @api
  */
-class ColumnValueExpression extends \Zend_Db_Expr
+class ColumnValueExpression extends MagentoDbExpression
 {
 }

lib/internal/Magento/Framework/DB/Sql/ConcatExpression.php

@@ -11,7 +11,7 @@
 /**
  * Class Concat
  */
-class ConcatExpression extends \Zend_Db_Expr
+class ConcatExpression extends MagentoDbExpression
 {
     /**
      * @var AdapterInterface

lib/internal/Magento/Framework/DB/Sql/LimitExpression.php

@@ -8,7 +8,7 @@
 /**
  * Class LimitExpression
  */
-class LimitExpression extends \Zend_Db_Expr
+class LimitExpression extends MagentoDbExpression
 {
     /**
      * @var string

lib/internal/Magento/Framework/DB/Sql/LookupExpression.php

@@ -12,7 +12,7 @@
 /**
  * Class LookupExpression
  */
-class LookupExpression extends \Zend_Db_Expr
+class LookupExpression extends MagentoDbExpression
 {
 
     /**

lib/internal/Magento/Framework/DB/Sql/JsonSerializableExpression.php renamed to lib/internal/Magento/Framework/DB/Sql/MagentoDbExpression.php

@@ -5,12 +5,10 @@
  */
 namespace Magento\Framework\DB\Sql;
 
-use Zend\Stdlib\JsonSerializable;
-
 /**
  * Class is wrapper over Zend_Db_Expr for implement JsonSerializable interface.
  */
-class JsonSerializableExpression extends \Zend_Db_Expr implements JsonSerializable
+class MagentoDbExpression extends \Zend_Db_Expr implements MagentoDbExpressionInterface
 {
     /**
      * @inheritdoc

lib/internal/Magento/Framework/DB/Sql/MagentoDbExpressionInterface.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\DB\Sql;
+
+use Zend\Stdlib\JsonSerializable;
+
+/**
+ * Interface MagentoDbExpressionInterface
+ *
+ * Defines interface was implemented in Zend_Db_Expr.
+ */
+interface MagentoDbExpressionInterface extends JsonSerializable
+{
+    /**
+     * @inheritdoc
+     */
+    public function __toString();
+}