Use shared faker-registry package (#309)

Author: jasonmccreary

composer.json

@@ -8,6 +8,7 @@
     ],
     "license": "MIT",
     "require": {
+        "laravel-shift/faker-registry": "^0.1",
         "symfony/yaml": "^4.3|^5.0",
         "illuminate/console": "^6.0|^7.0",
         "illuminate/filesystem": "^6.0|^7.0",
@@ -29,6 +30,9 @@
             "Tests\\": "tests/"
         }
     },
+    "config": {
+        "sort-packages": true
+    },
     "extra": {
         "laravel": {
             "providers": [

src/Generators/FactoryGenerator.php

@@ -5,6 +5,7 @@
 use Blueprint\Contracts\Generator;
 use Blueprint\Models\Column;
 use Blueprint\Models\Model;
+use Shift\Faker\Registry as FakerRegistry;
 use Blueprint\Tree;
 use Illuminate\Support\Str;
 
@@ -128,7 +129,7 @@ protected function buildDefinition(Model $model)
                 $definition .= ','.PHP_EOL;
             } elseif (in_array($column->dataType(), ['enum', 'set']) && ! empty($column->attributes())) {
                 $definition .= self::INDENT."'{$column->name()}' => ";
-                $faker = $this->fakerData($column->name()) ?? $this->fakerDataType($column->dataType());
+                $faker = FakerRegistry::fakerData($column->name()) ?? FakerRegistry::fakerDataType($column->dataType());
                 $definition .= '$faker->'.$faker;
                 $definition .= ','.PHP_EOL;
                 $definition = str_replace(
@@ -138,7 +139,7 @@ protected function buildDefinition(Model $model)
                 );
             } elseif (in_array($column->dataType(), ['decimal', 'double', 'float'])) {
                 $definition .= self::INDENT."'{$column->name()}' => ";
-                $faker = $this->fakerData($column->name()) ?? $this->fakerDataType($column->dataType());
+                $faker = FakerRegistry::fakerData($column->name()) ?? FakerRegistry::fakerDataType($column->dataType());
                 $definition .= '$faker->'.$faker;
                 $definition .= ','.PHP_EOL;
 
@@ -157,8 +158,8 @@ protected function buildDefinition(Model $model)
                 if ($column->isNullable()) {
                     continue;
                 }
-                $definition .= sprintf('%s%s => $faker->%s,%s', self::INDENT, "'{$column->name()}_id'", self::fakerDataType('id'), PHP_EOL);
-                $definition .= sprintf('%s%s => $faker->%s,%s', self::INDENT, "'{$column->name()}_type'", self::fakerDataType('string'), PHP_EOL);
+                $definition .= sprintf('%s%s => $faker->%s,%s', self::INDENT, "'{$column->name()}_id'", FakerRegistry::fakerDataType('id'), PHP_EOL);
+                $definition .= sprintf('%s%s => $faker->%s,%s', self::INDENT, "'{$column->name()}_type'", FakerRegistry::fakerDataType('string'), PHP_EOL);
             } elseif ($column->dataType() === 'rememberToken') {
                 $this->addImport($model, 'Illuminate\Support\Str');
                 $definition .= self::INDENT."'{$column->name()}' => ";
@@ -172,7 +173,7 @@ protected function buildDefinition(Model $model)
                     $type = 'unsigned'.$type;
                 }
 
-                $faker = self::fakerData($column->name()) ?? (self::fakerDataType($type) ?? self::fakerDataType($column->dataType()));
+                $faker = FakerRegistry::fakerData($column->name()) ?? (FakerRegistry::fakerDataType($type) ?? FakerRegistry::fakerDataType($column->dataType()));
 
                 if ($faker === null) {
                     $faker = 'word';
@@ -211,104 +212,4 @@ private function fillableColumns(array $columns): array
             return ! in_array('nullable', $column->modifiers());
         });
     }
-
-    public static function fakerData(string $name)
-    {
-        static $fakeableNames = [
-            'address1' => 'streetAddress',
-            'address2' => 'secondaryAddress',
-            'city' => 'city',
-            'company' => 'company',
-            'content' => 'paragraphs(3, true)',
-            'country' => 'country',
-            'description' => 'text',
-            'email' => 'safeEmail',
-            'first_name' => 'firstName',
-            'firstname' => 'firstName',
-            'guid' => 'uuid',
-            'last_name' => 'lastName',
-            'lastname' => 'lastName',
-            'lat' => 'latitude',
-            'latitude' => 'latitude',
-            'lng' => 'longitude',
-            'longitude' => 'longitude',
-            'name' => 'name',
-            'password' => 'password',
-            'phone' => 'phoneNumber',
-            'phone_number' => 'phoneNumber',
-            'postal_code' => 'postcode',
-            'postcode' => 'postcode',
-            'slug' => 'slug',
-            'ssn' => 'ssn',
-            'street' => 'streetName',
-            'summary' => 'text',
-            'title' => 'sentence(4)',
-            'url' => 'url',
-            'user_name' => 'userName',
-            'username' => 'userName',
-            'uuid' => 'uuid',
-            'zip' => 'postcode',
-        ];
-
-        return $fakeableNames[$name] ?? null;
-    }
-
-    public static function fakerDataType(string $type)
-    {
-        $fakeableTypes = [
-            'biginteger' => 'numberBetween(-100000, 100000)',
-            'binary' => 'sha256',
-            'boolean' => 'boolean',
-            'char' => 'randomLetter',
-            'date' => 'date()',
-            'datetime' => 'dateTime()',
-            'datetimetz' => 'dateTime()',
-            'decimal' => 'randomFloat(/** decimal_attributes **/)',
-            'double' => 'randomFloat(/** double_attributes **/)',
-            'enum' => 'randomElement(/** enum_attributes **/)',
-            'float' => 'randomFloat(/** float_attributes **/)',
-            'geometry' => 'word',
-            'geometrycollection' => 'word',
-            'guid' => 'uuid',
-            'id' => 'randomDigitNotNull',
-            'integer' => 'numberBetween(-10000, 10000)',
-            'ipaddress' => 'ipv4',
-            'linestring' => 'word',
-            'longtext' => 'text',
-            'macaddress' => 'macAddress',
-            'mediuminteger' => 'numberBetween(-10000, 10000)',
-            'mediumtext' => 'text',
-            'morphs_id' => 'randomDigitNotNull',
-            'morphs_type' => 'word',
-            'multilinestring' => 'word',
-            'multipoint' => 'word',
-            'multipolygon' => 'word',
-            'nullablemorphs' => null,
-            'nullabletimestamps' => null,
-            'nullableuuidmorphs' => null,
-            'point' => 'word',
-            'polygon' => 'word',
-            'set' => 'randomElement(/** set_attributes **/)',
-            'smallint' => 'numberBetween(-1000, 1000)',
-            'smallinteger' => 'numberBetween(-1000, 1000)',
-            'string' => 'word',
-            'text' => 'text',
-            'time' => 'time()',
-            'timestamp' => 'dateTime()',
-            'timestamptz' => 'dateTime()',
-            'timetz' => 'time()',
-            'tinyinteger' => 'numberBetween(-8, 8)',
-            'unsignedbiginteger' => 'randomNumber()',
-            'unsigneddecimal' => 'randomNumber()',
-            'unsignedinteger' => 'randomNumber()',
-            'unsignedmediuminteger' => 'randomNumber()',
-            'unsignedsmallinteger' => 'randomNumber()',
-            'unsignedtinyinteger' => 'randomDigitNotNull',
-            'uuid' => 'uuid',
-            'uuidmorphs' => 'word',
-            'year' => 'year()',
-        ];
-
-        return $fakeableTypes[strtolower($type)] ?? null;
-    }
 }

src/Generators/TestGenerator.php

@@ -17,6 +17,7 @@
 use Blueprint\Models\Statements\SendStatement;
 use Blueprint\Models\Statements\SessionStatement;
 use Blueprint\Models\Statements\ValidateStatement;
+use Shift\Faker\Registry as FakerRegistry;
 use Blueprint\Tree;
 use Illuminate\Support\Str;
 
@@ -236,7 +237,7 @@ protected function buildTestCases(Controller $controller)
                                 if ($factory) {
                                     [$faker, $variable_name] = $factory;
                                 } else {
-                                    $faker = sprintf('$%s = $this->faker->%s;', $data, FactoryGenerator::fakerData($local_column->name()) ?? FactoryGenerator::fakerDataType($local_model->column($column)->dataType()));
+                                    $faker = sprintf('$%s = $this->faker->%s;', $data, FakerRegistry::fakerData($local_column->name()) ?? FakerRegistry::fakerDataType($local_model->column($column)->dataType()));
                                 }
 
                                 $setup['data'][] = $faker;
@@ -255,7 +256,7 @@ protected function buildTestCases(Controller $controller)
                                     if ($factory) {
                                         [$faker, $variable_name] = $factory;
                                     } else {
-                                        $faker = sprintf('$%s = $this->faker->%s;', $local_column->name(), FactoryGenerator::fakerData($local_column->name()) ?? FactoryGenerator::fakerDataType($local_column->dataType()));
+                                        $faker = sprintf('$%s = $this->faker->%s;', $local_column->name(), FakerRegistry::fakerData($local_column->name()) ?? FakerRegistry::fakerDataType($local_column->dataType()));
                                         $variable_name = $local_column->name();
                                     }