danog/psalm-plugin-laravel
1
0
Fork 0
mirror of https://github.com/danog/psalm-plugin-laravel.git synced 2024-11-30 04:39:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add model property provider

Browse Source
This commit is contained in:
Matthew Brown 2020-01-05 18:46:59 -05:00
parent 4265b7d00b
commit 406eda6bf4
6 changed files with 224 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/AbstractPlugin.php
View File

@ -14,6 +14,8 @@ abstract class AbstractPlugin implements PluginEntryPointInterface
{
use CreatesApplication;
/** @var array<class-string> */
public static $model_classes = [];
/**
* Get and load ide provider for Laravel or Lumen Application container
@ -40,7 +42,7 @@ abstract class AbstractPlugin implements PluginEntryPointInterface
$app->register($ide_helper_provider);
}
$app = $this->loadIdeProvider($app, $ide_helper_provider);
$app = $this->loadIdeProvider($app, $ide_helper_provider);
$fake_filesystem = new FakeFilesystem();
@ -60,6 +62,8 @@ abstract class AbstractPlugin implements PluginEntryPointInterface
$registration->registerHooksFromClass(ReturnTypeProvider\ViewReturnTypeProvider::class);
require_once 'AppInterfaceProvider.php';
$registration->registerHooksFromClass(AppInterfaceProvider::class);
require_once 'PropertyProvider/ModelPropertyProvider.php';
$registration->registerHooksFromClass(PropertyProvider\ModelPropertyProvider::class);
}
/**
@ -91,8 +95,6 @@ abstract class AbstractPlugin implements PluginEntryPointInterface
);
$registration->addStubFile($cache_dir . 'stubs.php');
unlink($cache_dir . 'stubs.php');
}
/**
@ -105,7 +107,7 @@ abstract class AbstractPlugin implements PluginEntryPointInterface
\Illuminate\Filesystem\Filesystem $fake_filesystem,
$view_factory,
string $cache_dir
) {
) : void {
/** @psalm-suppress InvalidArgument */
$meta_generator_command = new FakeMetaCommand(
$fake_filesystem,
@ -123,10 +125,8 @@ abstract class AbstractPlugin implements PluginEntryPointInterface
new \Symfony\Component\Console\Input\ArrayInput([]),
new \Symfony\Component\Console\Output\NullOutput()
);
$registration->addStubFile($cache_dir . 'meta.php');
unlink($cache_dir . 'meta.php');
}
/**
@ -137,7 +137,7 @@ abstract class AbstractPlugin implements PluginEntryPointInterface
$app,
\Illuminate\Filesystem\Filesystem $fake_filesystem,
string $cache_dir
) {
) : void {
$migrations_folder = dirname(__DIR__, 4) . '/database/migrations/';
$project_analyzer = \Psalm\Internal\Analyzer\ProjectAnalyzer::getInstance();
@ -170,7 +170,7 @@ abstract class AbstractPlugin implements PluginEntryPointInterface
$registration->addStubFile($cache_dir . 'models.php');
unlink($cache_dir . 'models.php');
self::$model_classes = $models_generator_command->getModels();
}
/**

12
src/AppInterfaceProvider.php
View File

@ -91,13 +91,11 @@ class AppInterfaceProvider implements
string $called_fq_classlike_name = null,
string $called_method_name_lowercase = null
) {
if ($source) {
if ($method_name_lowercase === 'offsetget' || $method_name_lowercase === 'offsetset') {
return $source->getCodebase()->getMethodReturnType(
\Illuminate\Foundation\Application::class . '::' . $method_name_lowercase,
$fq_classlike_name
);
}
if ($method_name_lowercase === 'offsetget' || $method_name_lowercase === 'offsetset') {
return $source->getCodebase()->getMethodReturnType(
\Illuminate\Foundation\Application::class . '::' . $method_name_lowercase,
$fq_classlike_name
);
}
}
}

2
src/FakeModelsCommand.php
View File

@ -103,7 +103,7 @@ class FakeModelsCommand extends \Barryvdh\LaravelIdeHelper\Console\ModelsCommand
/**
* @param \Illuminate\Database\Eloquent\Model $model
*/
protected function getPropertiesFromMethods($model)
protected function getPropertiesFromMethods($model) : void
{
// do nothing here
}

119
src/PropertyProvider/ModelPropertyProvider.php Normal file
View File

@ -0,0 +1,119 @@
<?php
namespace Psalm\LaravelPlugin\PropertyProvider;
use PhpParser;
use Psalm\Context;
use Psalm\CodeLocation;
use Psalm\Type;
use Psalm\StatementsSource;
class ModelPropertyProvider
implements \Psalm\Plugin\Hook\PropertyExistenceProviderInterface,
\Psalm\Plugin\Hook\PropertyVisibilityProviderInterface,
\Psalm\Plugin\Hook\PropertyTypeProviderInterface
{
public static function getClassLikeNames() : array
{
return \Psalm\LaravelPlugin\AbstractPlugin::$model_classes;
}
/**
* @return ?bool
*/
public static function doesPropertyExist(
string $fq_classlike_name,
string $property_name,
bool $read_mode,
StatementsSource $source = null,
Context $context = null,
CodeLocation $code_location = null
) {
if (!$source || !$read_mode) {
return null;
}
$codebase = $source->getCodebase();
$class_like_storage = $codebase->classlike_storage_provider->get($fq_classlike_name);
if ($codebase->methodExists($fq_classlike_name . '::' . $property_name)) {
return true;
}
if ($codebase->methodExists($fq_classlike_name . '::get' . str_replace('_', '', $property_name) . 'Attribute')) {
return true;
}
if (isset($class_like_storage->pseudo_property_get_types['$' . $property_name])) {
return null;
}
return null;
}
/**
* @return ?bool
*/
public static function isPropertyVisible(
StatementsSource $source,
string $fq_classlike_name,
string $property_name,
bool $read_mode,
Context $context,
CodeLocation $code_location = null
) {
if (!$read_mode) {
return null;
}
$codebase = $source->getCodebase();
$class_like_storage = $codebase->classlike_storage_provider->get($fq_classlike_name);
if ($codebase->methodExists($fq_classlike_name . '::' . $property_name)) {
return true;
}
if ($codebase->methodExists($fq_classlike_name . '::get' . str_replace('_', '', $property_name) . 'Attribute')) {
return true;
}
if (isset($class_like_storage->pseudo_property_get_types['$' . $property_name])) {
return null;
}
return null;
}
/**
* @param array<PhpParser\Node\Arg> $call_args
*
* @return ?Type\Union
*/
public static function getPropertyType(
string $fq_classlike_name,
string $property_name,
bool $read_mode,
StatementsSource $source = null,
Context $context = null
) {
if (!$source || !$read_mode) {
return null;
}
$codebase = $source->getCodebase();
$class_like_storage = $codebase->classlike_storage_provider->get($fq_classlike_name);
if ($codebase->methodExists($fq_classlike_name . '::' . $property_name)) {
return $codebase->getMethodReturnType($fq_classlike_name . '::' . $property_name, $fq_classlike_name)
?: Type::getMixed();
}
if ($codebase->methodExists($fq_classlike_name . '::get' . str_replace('_', '', $property_name) . 'Attribute')) {
return $codebase->getMethodReturnType($fq_classlike_name . '::get' . str_replace('_', '', $property_name) . 'Attribute', $fq_classlike_name)
?: Type::getMixed();
}
}
}

175
src/SchemaAggregator.php
View File

@ -6,12 +6,12 @@ use PhpParser;
class SchemaAggregator
{
/** @var array<string, SchemaTable> */
public $tables = [];
public $tables = [];
/**
* @param array<int, PhpParser\Node\Stmt> $statements
* @param array<int, PhpParser\Node\Stmt> $stmts
*/
public function addStatements(array $stmts) : void
public function addStatements(array $stmts) : void
{
foreach ($stmts as $stmt) {
if ($stmt instanceof PhpParser\Node\Stmt\Class_) {
@ -21,7 +21,7 @@ class SchemaAggregator
}
/**
* @param array<int, PhpParser\Node\Stmt> $statements
* @param array<int, PhpParser\Node\Stmt> $stmts
*/
private function addClassStatements(array $stmts) : void
{
@ -35,7 +35,7 @@ class SchemaAggregator
}
/**
* @param array<int, PhpParser\Node\Stmt> $statements
* @param array<int, PhpParser\Node\Stmt> $stmts
*/
private function addUpMethodStatements(array $stmts) : void
{
@ -99,7 +99,7 @@ class SchemaAggregator
$this->processColumnUpdates($table_name, $call_arg_name, $update_closure->stmts);
}
private function dropTable(PhpParser\Node\Expr\StaticCall $call)
private function dropTable(PhpParser\Node\Expr\StaticCall $call) : void
{
if (!isset($call->args[0])
|| !$call->args[0]->value instanceof PhpParser\Node\Scalar\String_
@ -112,7 +112,7 @@ class SchemaAggregator
unset($this->tables[$table_name]);
}
private function renameTable(PhpParser\Node\Expr\StaticCall $call)
private function renameTable(PhpParser\Node\Expr\StaticCall $call) : void
{
if (!isset($call->args[0])
|| !$call->args[0]->value instanceof PhpParser\Node\Scalar\String_
@ -183,7 +183,38 @@ class SchemaAggregator
|| $first_method_call->name->name === 'nullableTimestampsTz'
|| $first_method_call->name->name === 'rememberToken'
) {
$column_name = null;
switch (strtolower($first_method_call->name->name)) {
case 'droptimestamps':
case 'droptimestampstz':
$table->dropColumn('created_at');
$table->dropColumn('updated_at');
break;
case 'remembertoken':
$table->setColumn(new SchemaColumn('remember_token', 'string', $nullable));
break;
case 'dropremembertoken':
$table->dropColumn('remember_token');
break;
case 'nullabletimestamps':
$table->setColumn(new SchemaColumn('created_at', 'string', true));
$table->setColumn(new SchemaColumn('updated_at', 'string', true));
break;
case 'timestamps':
$table->setColumn(new SchemaColumn('created_at', 'string', true));
$table->setColumn(new SchemaColumn('updated_at', 'string', true));
break;
case 'timestampstz':
$table->setColumn(new SchemaColumn('created_at', 'string', true));
$table->setColumn(new SchemaColumn('updated_at', 'string', true));
break;
}
continue;
} elseif ($first_method_call->name->name === 'softDeletes'
|| $first_method_call->name->name === 'softDeletesTz'
|| $first_method_call->name->name === 'dropSoftDeletes'
@ -209,12 +240,12 @@ class SchemaAggregator
}
}
switch ($first_method_call->name->name) {
case 'bigIncrements':
switch (strtolower($first_method_call->name->name)) {
case 'bigincrements':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'bigInteger':
case 'biginteger':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
@ -238,11 +269,11 @@ class SchemaAggregator
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
case 'dateTime':
case 'datetime':
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
case 'dateTimeTz':
case 'datetimetz':
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
@ -258,43 +289,35 @@ class SchemaAggregator
$table->dropColumn($column_name);
break;
case 'dropColumn':
case 'dropcolumn':
$table->dropColumn($column_name);
break;
case 'dropForeign':
case 'dropIndex':
case 'dropPrimary':
case 'dropUnique':
case 'dropSpatialIndex':
case 'dropforeign':
case 'dropindex':
case 'dropprimary':
case 'dropunique':
case 'dropspatialindex':
break;
case 'dropIfExists':
case 'dropifexists':
$table->dropColumn($column_name);
break;
case 'dropMorphs':
case 'dropmorphs':
$table->dropColumn($column_name . '_type');
$table->dropColumn($column_name . '_id');
break;
case 'dropRememberToken':
$table->dropColumn('remember_token');
break;
case 'dropSoftDeletes':
case 'dropsoftdeletes':
$table->dropColumn($column_name);
break;
case 'dropSoftDeletesTz':
case 'dropsoftdeletestz':
$table->dropColumn($column_name);
break;
case 'dropTimestamps':
case 'dropTimestampsTz':
$table->dropColumn('created_at');
$table->dropColumn('updated_at');
break;
case 'enum':
$table->setColumn(new SchemaColumn($column_name, 'enum', $nullable, $second_arg_array));
@ -311,11 +334,12 @@ class SchemaAggregator
$table->setColumn(new SchemaColumn($column_name, 'mixed', $nullable));
break;
case 'geometryCollection':
case 'geometrycollection':
$table->setColumn(new SchemaColumn($column_name, 'mixed', $nullable));
break;
case 'increments':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'index':
@ -325,11 +349,11 @@ class SchemaAggregator
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'integerIncrements':
case 'integerincrements':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'ipAddress':
case 'ipaddress':
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
@ -341,27 +365,27 @@ class SchemaAggregator
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
case 'lineString':
case 'linestring':
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
case 'longText':
case 'longtext':
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
case 'macAddress':
case 'macaddress':
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
case 'mediumIncrements':
case 'mediumincrements':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'mediumInteger':
case 'mediuminteger':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'mediumText':
case 'mediumtext':
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
@ -370,33 +394,28 @@ class SchemaAggregator
$table->setColumn(new SchemaColumn($column_name . '_id', 'int', $nullable));
break;
case 'multiLineString':
case 'multilinestring':
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
case 'multiPoint':
case 'multipoint':
$table->setColumn(new SchemaColumn($column_name, 'mixed', $nullable));
break;
case 'multiPolygon':
case 'multipolygon':
$table->setColumn(new SchemaColumn($column_name, 'mixed', $nullable));
break;
case 'multiPolygonZ':
case 'multipolygonz':
$table->setColumn(new SchemaColumn($column_name, 'mixed', $nullable));
break;
case 'nullableMorphs':
case 'nullablemorphs':
$table->setColumn(new SchemaColumn($column_name . '_type', 'string', true));
$table->setColumn(new SchemaColumn($column_name . '_id', 'int', true));
break;
case 'nullableTimestamps':
$table->setColumn(new SchemaColumn('created_at', 'string', true));
$table->setColumn(new SchemaColumn('updated_at', 'string', true));
break;
case 'nullableUuidMorphs':
case 'nullableuuidmorphs':
$table->setColumn(new SchemaColumn($column_name . '_type', 'string', true));
$table->setColumn(new SchemaColumn($column_name . '_id', 'string', true));
break;
@ -412,43 +431,37 @@ class SchemaAggregator
case 'primary':
break;
case 'rememberToken':
$table->setColumn(new SchemaColumn('remember_token', 'string', $nullable));
break;
case 'removeColumn':
case 'removecolumn':
$table->dropColumn($column_name);
break;
case 'rename':
case 'renamecolumn':
if ($second_arg instanceof PhpParser\Node\Scalar\String_) {
$table->renameColumn($column_name, $second_arg->value);
}
break;
case 'renameColumn':
break;
case 'renameIndex':
case 'renameindex':
break;
case 'set':
$table->setColumn(new SchemaColumn($column_name, 'set', $nullable, $second_arg_array));
break;
case 'smallIncrements':
case 'smallincrements':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'smallInteger':
case 'smallinteger':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'softDeletes':
case 'softdeletes':
$table->setColumn(new SchemaColumn($column_name, 'string', true));
break;
case 'softDeletesTz':
case 'softdeletestz':
$table->setColumn(new SchemaColumn($column_name, 'string', true));
break;
@ -471,56 +484,46 @@ class SchemaAggregator
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
case 'timestamps':
$table->setColumn(new SchemaColumn('created_at', 'string', true));
$table->setColumn(new SchemaColumn('updated_at', 'string', true));
break;
case 'timestampsTz':
$table->setColumn(new SchemaColumn('created_at', 'string', true));
$table->setColumn(new SchemaColumn('updated_at', 'string', true));
break;
case 'timestampTz':
case 'timestamptz':
$table->setColumn(new SchemaColumn($column_name, 'string', true));
break;
case 'timeTz':
case 'timetz':
$table->setColumn(new SchemaColumn($column_name, 'string', true));
break;
case 'tinyIncrements':
case 'tinyincrements':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'tinyInteger':
case 'tinyinteger':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'unique':
break;
case 'unsignedBigInteger':
case 'unsignedbiginteger':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'unsignedDecimal':
case 'unsigneddecimal':
$table->setColumn(new SchemaColumn($column_name, 'float', $nullable));
break;
case 'unsignedInteger':
case 'unsignedinteger':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'unsignedMediumInteger':
case 'unsignedmediuminteger':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'unsignedSmallInteger':
case 'unsignedsmallinteger':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
case 'unsignedTinyInteger':
case 'unsignedtinyinteger':
$table->setColumn(new SchemaColumn($column_name, 'int', $nullable));
break;
@ -528,7 +531,7 @@ class SchemaAggregator
$table->setColumn(new SchemaColumn($column_name, 'string', $nullable));
break;
case 'uuidMorphs':
case 'uuidmorphs':
$table->setColumn(new SchemaColumn($column_name . '_type', 'string', $nullable));
$table->setColumn(new SchemaColumn($column_name . '_id', 'string', $nullable));
break;

2
src/SchemaTable.php
View File

@ -21,7 +21,7 @@ class SchemaTable
public function renameColumn(string $old_name, string $new_name) : void
{
if (!isset($this->columns[$column->name])) {
if (!isset($this->columns[$old_name])) {
return;
}