MAGETWO-37848: Generate data fails when table prefix exceeds length of 5

 - update docblock descriptions and typehints

Author: Dale Sikkema

lib/internal/Magento/Framework/DB/Adapter/Pdo/Mysql.php

@@ -3123,7 +3123,7 @@ public function getDateExtractSql($date, $unit)
      *
      * @param string $tableName
      * @return string
-     * @codeCoverageIgnore Covered by tests on ExpressionConverter
+     * @codeCoverageIgnore
      */
     public function getTableName($tableName)
     {
@@ -3137,7 +3137,7 @@ public function getTableName($tableName)
      * @param string $time  Either "before" or "after"
      * @param string $event  The DB level event which activates the trigger, i.e. "update" or "insert"
      * @return string
-     * @codeCoverageIgnore Covered by tests on ExpressionConverter
+     * @codeCoverageIgnore
      */
 
     public function getTriggerName($tableName, $time, $event)
@@ -3184,6 +3184,7 @@ public function getIndexName($tableName, $fields, $indexType = '')
      * @param string $refTableName
      * @param string $refColumnName
      * @return string
+     * @codeCoverageIgnore
      */
     public function getForeignKeyName($priTableName, $priColumnName, $refTableName, $refColumnName)
     {

lib/internal/Magento/Framework/DB/ExpressionConverter.php

@@ -15,7 +15,7 @@ class ExpressionConverter
     const MYSQL_IDENTIFIER_LEN = 64;
 
     /**
-     * Dictionary for generate short name
+     * Dictionary maps common words in identifiers to abbreviations
      *
      * @var array
      */
@@ -67,7 +67,7 @@ class ExpressionConverter
     ];
 
     /**
-     * Convert name using dictionary
+     * Shorten name by abbreviating words
      *
      * @param string $name
      * @return string
@@ -78,7 +78,7 @@ public static function shortName($name)
     }
 
     /**
-     * Add or replace translate to dictionary
+     * Add an abbreviation to the dictionary, or replace if it already exists
      *
      * @param string $from
      * @param string $to
@@ -90,30 +90,33 @@ public static function addTranslate($from, $to)
     }
 
     /**
-     * @param string $tableName
+     * Shorten the name of a MySql identifier, by abbreviating common words and hashing if necessary. Prepends the
+     * given prefix to clarify what kind of entity the identifier represents, in case hashing is used.
+     *
+     * @param string $entityName
      * @param string $prefix
      * @return string
      */
-    public static function shortenEntityName($tableName, $prefix)
+    public static function shortenEntityName($entityName, $prefix)
     {
-        if (strlen($tableName) > self::MYSQL_IDENTIFIER_LEN) {
-            $shortName = ExpressionConverter::shortName($tableName);
+        if (strlen($entityName) > self::MYSQL_IDENTIFIER_LEN) {
+            $shortName = ExpressionConverter::shortName($entityName);
             if (strlen($shortName) > self::MYSQL_IDENTIFIER_LEN) {
-                $hash = md5($tableName);
+                $hash = md5($entityName);
                 if (strlen($prefix . $hash) > self::MYSQL_IDENTIFIER_LEN) {
-                    $tableName = self::trimHash($hash, $prefix, self::MYSQL_IDENTIFIER_LEN);
+                    $entityName = self::trimHash($hash, $prefix, self::MYSQL_IDENTIFIER_LEN);
                 } else {
-                    $tableName = $prefix . $hash;
+                    $entityName = $prefix . $hash;
                 }
             } else {
-                $tableName = $shortName;
+                $entityName = $shortName;
             }
         }
-        return $tableName;
+        return $entityName;
     }
 
     /**
-     * Remove superfluous characters from hash.
+     * Remove superfluous characters from hash
      *
      * @param  string $hash
      * @param  string $prefix

lib/internal/Magento/Framework/Mview/View/Subscription.php

@@ -10,7 +10,6 @@
 
 use Magento\Framework\App\Resource;
 use Magento\Framework\DB\Ddl\Trigger;
-use Magento\Framework\DB\ExpressionConverter;
 
 class Subscription implements SubscriptionInterface
 {
@@ -22,7 +21,7 @@ class Subscription implements SubscriptionInterface
     protected $write;
 
     /**
-     * @var Trigger
+     * @var \Magento\Framework\DB\Ddl\TriggerFactory
      */
     protected $triggerFactory;