danog/psalm-plugin-laravel
1
0
Fork 0
mirror of https://github.com/danog/psalm-plugin-laravel.git synced 2025-01-22 05:11:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11 from pthiers/master

Browse Source 
Lumen psalm plugin
This commit is contained in:
Matthew Brown 2019-09-24 16:36:18 -04:00 committed by GitHub
commit 4f255fca9e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 161 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

131
src/AbstractPlugin.php Normal file
View File

@ -0,0 +1,131 @@
<?php
namespace Psalm\LaravelPlugin;
use Illuminate\View\Engines\EngineResolver;
use Illuminate\View\Engines\PhpEngine;
use Illuminate\View\Factory;
use Illuminate\View\FileViewFinder;
use Orchestra\Testbench\Concerns\CreatesApplication;
use Psalm\Plugin\PluginEntryPointInterface;
use Psalm\Plugin\RegistrationInterface;
use SimpleXMLElement;
abstract class AbstractPlugin implements PluginEntryPointInterface
{
use CreatesApplication;
/**
* Get and load ide provider for Laravel or Lumen Application container
*
* @param \Illuminate\Container\Container $app
* @param string $ide_helper_provider
* @return \Illuminate\Contracts\Foundation\Application|\Laravel\Lumen\Application|\Illuminate\Container\Container
*/
abstract function loadIdeProvider($app, $ide_helper_provider);
/**
* @return void
*/
public function __invoke(RegistrationInterface $registration, ?SimpleXMLElement $config = null)
{
$ide_helper_provider = \Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class;
if (file_exists($applicationPath = __DIR__.'/../../../../bootstrap/app.php')) { // Applications
$app = require $applicationPath;
} elseif (file_exists($applicationPath = getcwd().'/bootstrap/app.php')) { // Local Dev
$app = require $applicationPath;
} else { // Packages
$app = (new static)->loadIdeProvider();
$app->register($ide_helper_provider);
}
$app = $this->getApplicationInstance($app, $ide_helper_provider);
$fake_filesystem = new FakeFilesystem();
$view_factory = $this->getViewFactory($app, $fake_filesystem);
$stubs_generator_command = new \Barryvdh\LaravelIdeHelper\Console\GeneratorCommand(
$app['config'],
$fake_filesystem,
$view_factory
);
$stubs_generator_command->setLaravel($app);
$cache_dir = __DIR__ . DIRECTORY_SEPARATOR . 'cache' . DIRECTORY_SEPARATOR;
$fake_filesystem->setDestination($cache_dir . 'stubs.php');
$stubs_generator_command->run(
new \Symfony\Component\Console\Input\ArrayInput([]),
new \Symfony\Component\Console\Output\NullOutput()
);
/** @psalm-suppress InvalidArgument */
$meta_generator_command = new FakeMetaCommand(
$fake_filesystem,
$view_factory,
$app['config']
);
$meta_generator_command->setLaravel($app);
$fake_filesystem->setDestination($cache_dir . 'meta.php');
$meta_generator_command->run(
new \Symfony\Component\Console\Input\ArrayInput([]),
new \Symfony\Component\Console\Output\NullOutput()
);
$registration->addStubFile($cache_dir . 'stubs.php');
$registration->addStubFile($cache_dir . 'meta.php');
require_once 'ReturnTypeProvider/AuthReturnTypeProvider.php';
$registration->registerHooksFromClass(ReturnTypeProvider\AuthReturnTypeProvider::class);
require_once 'ReturnTypeProvider/TransReturnTypeProvider.php';
$registration->registerHooksFromClass(ReturnTypeProvider\TransReturnTypeProvider::class);
require_once 'ReturnTypeProvider/ViewReturnTypeProvider.php';
$registration->registerHooksFromClass(ReturnTypeProvider\ViewReturnTypeProvider::class);
require_once 'AppInterfaceProvider.php';
$registration->registerHooksFromClass(AppInterfaceProvider::class);
}
/**
* Undocumented function
*
* @param \Illuminate\Contracts\Foundation\Application|\Laravel\Lumen\Application|\Illuminate\Container\Container $app
* @param FakeFilesystem $fake_filesystem
* @return Factory
*/
private function getViewFactory(
\Illuminate\Container\Container $app,
FakeFilesystem $fake_filesystem
) : Factory {
$service_helper_reflection = new \ReflectionClass(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
$file_path = $service_helper_reflection->getFileName();
if (!$file_path) {
throw new \UnexpectedValueException('Service helper should have a file path');
}
$resolver = new EngineResolver();
$resolver->register('php', function () : PhpEngine {
return new PhpEngine();
});
$finder = new FileViewFinder($fake_filesystem, [dirname($file_path) . '/../resources/views']);
$factory = new Factory($resolver, $finder, new \Illuminate\Events\Dispatcher());
$factory->addExtension('php', 'php');
return $factory;
}
/**
* @param \Illuminate\Foundation\Application $app
*/
protected function getEnvironmentSetUp($app): void
{
// ..
}
}

21
src/LumenPlugin.php Normal file
View File

@ -0,0 +1,21 @@
<?php
namespace Psalm\LaravelPlugin;
class LumenPlugin extends AbstractPlugin implements PluginEntryPointInterface
{
/**
* Get and load ide provider for Lumen Application container
*
* @param \Illuminate\Container\Container $app
* @param string $ide_helper_provider
* @return \Illuminate\Contracts\Foundation\Application|\Laravel\Lumen\Application|\Illuminate\Container\Container
*/
public function loadIdeProvider($app, $ide_helper_provider){
if ($app instanceof \Laravel\Lumen\Application) {
/** @var \Illuminate\Contracts\Http\Kernel $kernel */
$kernel = $app->make(\Illuminate\Contracts\Console\Kernel::class);
$app->register($ide_helper_provider);
}
return $app;
}
}

104
src/Plugin.php
View File

@ -10,26 +10,18 @@ use Psalm\Plugin\PluginEntryPointInterface;
use Psalm\Plugin\RegistrationInterface;
use SimpleXMLElement;
class Plugin implements PluginEntryPointInterface
class Plugin extends AbstractPlugin implements PluginEntryPointInterface
{
use CreatesApplication;
/**
* @return void
* Get and load ide provider for Laravel Application container
*
* @param \Illuminate\Container\Container $app
* @param string $ide_helper_provider
* @return \Illuminate\Contracts\Foundation\Application|\Laravel\Lumen\Application|\Illuminate\Container\Container
*/
public function __invoke(RegistrationInterface $registration, ?SimpleXMLElement $config = null)
{
$ide_helper_provider = \Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class;
if (file_exists($applicationPath = __DIR__.'/../../../../bootstrap/app.php')) { // Applications
$app = require $applicationPath;
} elseif (file_exists($applicationPath = getcwd().'/bootstrap/app.php')) { // Local Dev
$app = require $applicationPath;
} else { // Packages
$app = (new self)->createApplication();
$app->register($ide_helper_provider);
}
public function loadIdeProvider($app, $ide_helper_provider){
if ($app instanceof \Illuminate\Contracts\Foundation\Application) {
/** @var \Illuminate\Contracts\Http\Kernel $kernel */
$kernel = $app->make(\Illuminate\Contracts\Console\Kernel::class);
@ -43,84 +35,6 @@ class Plugin implements PluginEntryPointInterface
$app->register($ide_helper_provider);
}
}
$fake_filesystem = new FakeFilesystem();
$view_factory = $this->getViewFactory($app, $fake_filesystem);
$stubs_generator_command = new \Barryvdh\LaravelIdeHelper\Console\GeneratorCommand(
$app['config'],
$fake_filesystem,
$view_factory
);
$stubs_generator_command->setLaravel($app);
$cache_dir = __DIR__ . DIRECTORY_SEPARATOR . 'cache' . DIRECTORY_SEPARATOR;
$fake_filesystem->setDestination($cache_dir . 'stubs.php');
$stubs_generator_command->run(
new \Symfony\Component\Console\Input\ArrayInput([]),
new \Symfony\Component\Console\Output\NullOutput()
);
/** @psalm-suppress InvalidArgument */
$meta_generator_command = new FakeMetaCommand(
$fake_filesystem,
$view_factory,
$app['config']
);
$meta_generator_command->setLaravel($app);
$fake_filesystem->setDestination($cache_dir . 'meta.php');
$meta_generator_command->run(
new \Symfony\Component\Console\Input\ArrayInput([]),
new \Symfony\Component\Console\Output\NullOutput()
);
$registration->addStubFile($cache_dir . 'stubs.php');
$registration->addStubFile($cache_dir . 'meta.php');
require_once 'ReturnTypeProvider/AuthReturnTypeProvider.php';
$registration->registerHooksFromClass(ReturnTypeProvider\AuthReturnTypeProvider::class);
require_once 'ReturnTypeProvider/TransReturnTypeProvider.php';
$registration->registerHooksFromClass(ReturnTypeProvider\TransReturnTypeProvider::class);
require_once 'ReturnTypeProvider/ViewReturnTypeProvider.php';
$registration->registerHooksFromClass(ReturnTypeProvider\ViewReturnTypeProvider::class);
require_once 'AppInterfaceProvider.php';
$registration->registerHooksFromClass(AppInterfaceProvider::class);
}
private function getViewFactory(
\Illuminate\Contracts\Foundation\Application $app,
FakeFilesystem $fake_filesystem
) : Factory {
$service_helper_reflection = new \ReflectionClass(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
$file_path = $service_helper_reflection->getFileName();
if (!$file_path) {
throw new \UnexpectedValueException('Service helper should have a file path');
}
$resolver = new EngineResolver();
$resolver->register('php', function () : PhpEngine {
return new PhpEngine();
});
$finder = new FileViewFinder($fake_filesystem, [dirname($file_path) . '/../resources/views']);
$factory = new Factory($resolver, $finder, new \Illuminate\Events\Dispatcher());
$factory->addExtension('php', 'php');
return $factory;
}
/**
* @param \Illuminate\Foundation\Application $app
*/
protected function getEnvironmentSetUp($app): void
{
// ..
return $app;
}
}