mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 01:57:13 +00:00
* Revert #1629 - Allow adding custom Macroable classes * Add Macros test
This commit is contained in:
@@ -115,8 +115,6 @@ Str::macro('concat', function(string $str1, string $str2) : string {
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
You can add any custom Macroable traits to detect in the `macroable_traits` config option.
|
|
||||||
|
|
||||||
### Automatic PHPDocs for models
|
### Automatic PHPDocs for models
|
||||||
|
|
||||||
If you don't want to write your properties yourself, you can use the command `php artisan ide-helper:models` to generate
|
If you don't want to write your properties yourself, you can use the command `php artisan ide-helper:models` to generate
|
||||||
|
|||||||
@@ -335,18 +335,4 @@ return [
|
|||||||
// 'ide-helper:models --nowrite',
|
// 'ide-helper:models --nowrite',
|
||||||
],
|
],
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Macroable Traits
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Define which traits should be considered capable of adding Macro.
|
|
||||||
| You can add any custom trait that behaves like the original Laravel one.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'macroable_traits' => [
|
|
||||||
Filament\Support\Concerns\Macroable::class,
|
|
||||||
Spatie\Macroable\Macroable::class,
|
|
||||||
],
|
|
||||||
|
|
||||||
];
|
];
|
||||||
|
|||||||
+3
-5
@@ -22,6 +22,7 @@ use Illuminate\Config\Repository as ConfigRepository;
|
|||||||
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
||||||
use Illuminate\Database\Query\Builder as QueryBuilder;
|
use Illuminate\Database\Query\Builder as QueryBuilder;
|
||||||
use Illuminate\Support\Facades\Facade;
|
use Illuminate\Support\Facades\Facade;
|
||||||
|
use Illuminate\Support\Traits\Macroable;
|
||||||
use ReflectionClass;
|
use ReflectionClass;
|
||||||
use Throwable;
|
use Throwable;
|
||||||
|
|
||||||
@@ -47,8 +48,6 @@ class Alias
|
|||||||
protected $phpdoc = null;
|
protected $phpdoc = null;
|
||||||
protected $classAliases = [];
|
protected $classAliases = [];
|
||||||
|
|
||||||
protected $isMacroable = false;
|
|
||||||
|
|
||||||
/** @var ConfigRepository */
|
/** @var ConfigRepository */
|
||||||
protected $config;
|
protected $config;
|
||||||
|
|
||||||
@@ -63,13 +62,12 @@ class Alias
|
|||||||
* @param array $magicMethods
|
* @param array $magicMethods
|
||||||
* @param array $interfaces
|
* @param array $interfaces
|
||||||
*/
|
*/
|
||||||
public function __construct($config, $alias, $facade, $magicMethods = [], $interfaces = [], $isMacroable = false)
|
public function __construct($config, $alias, $facade, $magicMethods = [], $interfaces = [])
|
||||||
{
|
{
|
||||||
$this->alias = $alias;
|
$this->alias = $alias;
|
||||||
$this->magicMethods = $magicMethods;
|
$this->magicMethods = $magicMethods;
|
||||||
$this->interfaces = $interfaces;
|
$this->interfaces = $interfaces;
|
||||||
$this->config = $config;
|
$this->config = $config;
|
||||||
$this->isMacroable = $isMacroable;
|
|
||||||
|
|
||||||
// Make the class absolute
|
// Make the class absolute
|
||||||
$facade = '\\' . ltrim($facade, '\\');
|
$facade = '\\' . ltrim($facade, '\\');
|
||||||
@@ -431,7 +429,7 @@ class Alias
|
|||||||
|
|
||||||
// Check if the class is macroable
|
// Check if the class is macroable
|
||||||
// (Eloquent\Builder is also macroable but doesn't use Macroable trait)
|
// (Eloquent\Builder is also macroable but doesn't use Macroable trait)
|
||||||
if ($this->isMacroable || $class === EloquentBuilder::class) {
|
if ($class === EloquentBuilder::class || in_array(Macroable::class, $reflection->getTraitNames())) {
|
||||||
$properties = $reflection->getStaticProperties();
|
$properties = $reflection->getStaticProperties();
|
||||||
$macros = isset($properties['macros']) ? $properties['macros'] : [];
|
$macros = isset($properties['macros']) ? $properties['macros'] : [];
|
||||||
foreach ($macros as $macro_name => $macro_func) {
|
foreach ($macros as $macro_name => $macro_func) {
|
||||||
|
|||||||
+3
-14
@@ -35,7 +35,6 @@ class Generator
|
|||||||
protected $magic = [];
|
protected $magic = [];
|
||||||
protected $interfaces = [];
|
protected $interfaces = [];
|
||||||
protected $helpers;
|
protected $helpers;
|
||||||
protected array $macroableTraits = [];
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \Illuminate\Config\Repository $config
|
* @param \Illuminate\Config\Repository $config
|
||||||
@@ -360,7 +359,7 @@ class Generator
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
$aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces, true);
|
$aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -382,18 +381,8 @@ class Generator
|
|||||||
->filter(function ($class) {
|
->filter(function ($class) {
|
||||||
$traits = class_uses_recursive($class);
|
$traits = class_uses_recursive($class);
|
||||||
|
|
||||||
if (isset($traits[Macroable::class])) {
|
// Filter only classes with the macroable trait
|
||||||
return true;
|
return isset($traits[Macroable::class]);
|
||||||
}
|
|
||||||
|
|
||||||
// Filter only classes with a macroable trait
|
|
||||||
foreach ($this->config->get('ide-helper.macroable_traits', []) as $trait) {
|
|
||||||
if (isset($traits[$trait])) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false;
|
|
||||||
})
|
})
|
||||||
->filter(function ($class) use ($aliases) {
|
->filter(function ($class) use ($aliases) {
|
||||||
$class = Str::start($class, '\\');
|
$class = Str::start($class, '\\');
|
||||||
|
|||||||
+27
-1
@@ -7,6 +7,7 @@ namespace Barryvdh\LaravelIdeHelper\Tests;
|
|||||||
use Barryvdh\LaravelIdeHelper\Alias;
|
use Barryvdh\LaravelIdeHelper\Alias;
|
||||||
use Barryvdh\LaravelIdeHelper\Macro;
|
use Barryvdh\LaravelIdeHelper\Macro;
|
||||||
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
||||||
|
use Illuminate\Database\Query\Builder;
|
||||||
use Illuminate\Support\Arr;
|
use Illuminate\Support\Arr;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -15,6 +16,31 @@ use Illuminate\Support\Arr;
|
|||||||
*/
|
*/
|
||||||
class AliasTest extends TestCase
|
class AliasTest extends TestCase
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* @covers ::detectMethods
|
||||||
|
*/
|
||||||
|
public function testDetectMethodsMacroableMacros(): void
|
||||||
|
{
|
||||||
|
// Mock
|
||||||
|
$macro = __FUNCTION__;
|
||||||
|
$alias = new AliasMock();
|
||||||
|
|
||||||
|
// Macros
|
||||||
|
Builder::macro(
|
||||||
|
$macro,
|
||||||
|
function () {
|
||||||
|
// empty
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
// Prepare
|
||||||
|
$alias->setClasses([Builder::class]);
|
||||||
|
$alias->detectMethods();
|
||||||
|
|
||||||
|
// Test
|
||||||
|
$this->assertNotNull($this->getAliasMacro($alias, Builder::class, $macro));
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @covers ::detectMethods
|
* @covers ::detectMethods
|
||||||
*/
|
*/
|
||||||
@@ -24,7 +50,7 @@ class AliasTest extends TestCase
|
|||||||
$macro = __FUNCTION__;
|
$macro = __FUNCTION__;
|
||||||
$alias = new AliasMock();
|
$alias = new AliasMock();
|
||||||
|
|
||||||
// Macrosx
|
// Macros
|
||||||
EloquentBuilder::macro(
|
EloquentBuilder::macro(
|
||||||
$macro,
|
$macro,
|
||||||
function () {
|
function () {
|
||||||
|
|||||||
@@ -6,18 +6,26 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\GenerateIdeHe
|
|||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
|
||||||
|
use Illuminate\Support\Arr;
|
||||||
|
use Illuminate\Support\Facades\DB;
|
||||||
|
|
||||||
class Test extends AbstractGeneratorCommand
|
class Test extends AbstractGeneratorCommand
|
||||||
{
|
{
|
||||||
public function testGenerator(): void
|
public function testGenerator(): void
|
||||||
{
|
{
|
||||||
|
Arr::macro('arr_custom_macro',function(){});
|
||||||
|
DB::macro('db_custom_macro',function(){});
|
||||||
|
|
||||||
$command = $this->app->make(GeneratorCommand::class);
|
$command = $this->app->make(GeneratorCommand::class);
|
||||||
|
|
||||||
$tester = $this->runCommand($command);
|
$tester = $this->runCommand($command);
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
$this->assertSame(0, $tester->getStatusCode());
|
||||||
|
|
||||||
$this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
|
$this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
|
||||||
$this->assertStringContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
|
$this->assertStringContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
|
||||||
|
$this->assertStringContainsString('public static function arr_custom_macro()', $this->mockFilesystemOutput);
|
||||||
|
$this->assertStringContainsString('public static function db_custom_macro()', $this->mockFilesystemOutput);
|
||||||
}
|
}
|
||||||
|
|
||||||
public function testFilename(): void
|
public function testFilename(): void
|
||||||
|
|||||||
Reference in New Issue
Block a user