Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

If you don't want to write your properties yourself, you can use the command `php artisan ide-helper:models` to generate
Expand Down
14 changes: 0 additions & 14 deletions config/ide-helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -335,18 +335,4 @@
// '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,
],

];
8 changes: 3 additions & 5 deletions src/Alias.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
use Illuminate\Database\Query\Builder as QueryBuilder;
use Illuminate\Support\Facades\Facade;
use Illuminate\Support\Traits\Macroable;
use ReflectionClass;
use Throwable;

Expand All @@ -47,8 +48,6 @@ class Alias
protected $phpdoc = null;
protected $classAliases = [];

protected $isMacroable = false;

/** @var ConfigRepository */
protected $config;

Expand All @@ -63,13 +62,12 @@ class Alias
* @param array $magicMethods
* @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->magicMethods = $magicMethods;
$this->interfaces = $interfaces;
$this->config = $config;
$this->isMacroable = $isMacroable;

// Make the class absolute
$facade = '\\' . ltrim($facade, '\\');
Expand Down Expand Up @@ -431,7 +429,7 @@ protected function detectMethods()

// Check if the class is macroable
// (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();
$macros = isset($properties['macros']) ? $properties['macros'] : [];
foreach ($macros as $macro_name => $macro_func) {
Expand Down
17 changes: 3 additions & 14 deletions src/Generator.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ class Generator
protected $magic = [];
protected $interfaces = [];
protected $helpers;
protected array $macroableTraits = [];

/**
* @param \Illuminate\Config\Repository $config
Expand Down Expand Up @@ -360,7 +359,7 @@ protected function addMacroableClasses(Collection $aliases)
continue;
}

$aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces, true);
$aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces);
}
}

Expand All @@ -382,18 +381,8 @@ protected function getMacroableClasses(Collection $aliases)
->filter(function ($class) {
$traits = class_uses_recursive($class);

if (isset($traits[Macroable::class])) {
return true;
}

// 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 only classes with the macroable trait
return isset($traits[Macroable::class]);
})
->filter(function ($class) use ($aliases) {
$class = Str::start($class, '\\');
Expand Down
28 changes: 27 additions & 1 deletion tests/AliasTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Barryvdh\LaravelIdeHelper\Alias;
use Barryvdh\LaravelIdeHelper\Macro;
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
use Illuminate\Database\Query\Builder;
use Illuminate\Support\Arr;

/**
Expand All @@ -15,6 +16,31 @@
*/
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
*/
Expand All @@ -24,7 +50,7 @@ public function testDetectMethodsEloquentBuilderMacros(): void
$macro = __FUNCTION__;
$alias = new AliasMock();

// Macrosx
// Macros
EloquentBuilder::macro(
$macro,
function () {
Expand Down
8 changes: 8 additions & 0 deletions tests/Console/GeneratorCommand/GenerateIdeHelper/Test.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,26 @@

use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;

class Test extends AbstractGeneratorCommand
{
public function testGenerator(): void
{
Arr::macro('arr_custom_macro',function(){});
DB::macro('db_custom_macro',function(){});

$command = $this->app->make(GeneratorCommand::class);

$tester = $this->runCommand($command);

$this->assertSame(0, $tester->getStatusCode());

$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 arr_custom_macro()', $this->mockFilesystemOutput);
$this->assertStringContainsString('public static function db_custom_macro()', $this->mockFilesystemOutput);
}

public function testFilename(): void
Expand Down
Loading