7254443569

Committed 18 Dec 2023 10:14PM UTC coverage: 73.72% (-0.2%) from 73.873%

Build # 7254443569

Build Type

push

github

Committed by

web-flow

Commit Message

Feature/custom config field support (#6)

* refactor so configs related to user attributes can be fetched + better livewire support

* let devs add custom config fields

* remove changelog workflow

Run Details

43 of 67 new or added lines in 8 files covered. (64.18%)

1 existing line in 1 file now uncovered.

1296 of 1758 relevant lines covered (73.72%)

30.13 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.35

/src/FilamentUserAttributes.php

<?php

namespace Luttje\FilamentUserAttributes;

use Closure;
use Filament\Forms\Components\Component;
use Filament\Forms\Components\Fieldset;
use Filament\Forms\Components\Section;
use Filament\Forms\Components\Tabs;
use Filament\Forms\Components\Tabs\Tab;
use Filament\Tables\Columns\Column;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Str;
use Luttje\FilamentUserAttributes\Contracts\ConfiguresUserAttributesContract;
use Luttje\FilamentUserAttributes\Contracts\UserAttributesConfigContract;
use Luttje\FilamentUserAttributes\Filament\UserAttributeComponentFactoryRegistry;
use Luttje\FilamentUserAttributes\Models\UserAttributeConfig;
use Luttje\FilamentUserAttributes\Traits\ConfiguresUserAttributes;

/**
 * Class FilamentUserAttributes
 *
 * This class provides functionality for managing user attributes in Filament admin
 * panels. It handles the registration and discovery of resources, user attribute
 * components, and facilitates the integration of custom fields and columns in
 * Filament resources.
 */
class FilamentUserAttributes
{
    /**
     * @var array|Closure List of registered resources or a closure that returns resources.
     */
    protected array | Closure $registeredResources = [];

    /**
     * @var array List of registered user attribute config components.
     */
    protected array $registeredConfigComponents = [];

    /**
     * @var array|null Cached list of discovered resources.
     */
    protected ?array $cachedDiscoveredResources = null;

    /**
     * @var string Path to the application directory.
     */
    protected string $appPath;

    /**
     * @var string Namespace of the application.
     */
    protected string $appNamespace;

    /**
     * Constructor for FilamentUserAttributes.
     *
     * @param string|null $appPath       Optional path to the application directory.
     * @param string|null $appNamespace  Optional namespace of the application.
     */
    public function __construct(string $appPath = null, string $appNamespace = null)
    {
        $this->appNamespace = $appNamespace ?? app()->getNamespace();
        $this->appPath = $appPath ?? app_path();

        $this->appNamespace = rtrim($this->appNamespace, '\\') . '\\';
        $this->appPath = rtrim($this->appPath, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
    }

    /**
     * Returns whether the component can have child components.
     */
    public function componentHasChildren(Component $component): bool
    {
        return $component instanceof Tabs
            || $component instanceof Tab
            || $component instanceof Section
            || $component instanceof Fieldset;
    }

    /**
     * Register resources that can be configured with user attributes.
     * You can provide an associative array of resources, where the key
     * is the resource class and the value is the resource label to show
     * to users.
     *
     * You can also provide a closure that returns an array of resources
     * in the same format.
     *
     * Call this in your AppServiceProvider's boot function.
     */
    public function registerResources(array | Closure $resources): void
    {
        if (config('filament-user-attributes.discover_resources') !== false) {
            throw new \Exception("You cannot register resources when the 'filament-user-attributes.discover_resources' config option is enabled. Set it to false.");
        }

        if (is_array($resources)) {
            $this->registeredResources = array_merge($this->registeredResources, $resources);
        } elseif ($resources instanceof Closure) {
            $this->registeredResources = $resources;
        }
    }

    /**
     * Registers all types of user attribute field factories.
     */
    public function registerDefaultUserAttributeComponentFactories(): void
    {
        UserAttributeComponentFactoryRegistry::register('text', \Luttje\FilamentUserAttributes\Filament\Factories\TextComponentFactory::class);
        UserAttributeComponentFactoryRegistry::register('number', \Luttje\FilamentUserAttributes\Filament\Factories\NumberInputComponentFactory::class);
        UserAttributeComponentFactoryRegistry::register('textarea', \Luttje\FilamentUserAttributes\Filament\Factories\TextareaComponentFactory::class);
        UserAttributeComponentFactoryRegistry::register('richeditor', \Luttje\FilamentUserAttributes\Filament\Factories\RichEditorComponentFactory::class);
        UserAttributeComponentFactoryRegistry::register('tags', \Luttje\FilamentUserAttributes\Filament\Factories\TagsInputComponentFactory::class);

        UserAttributeComponentFactoryRegistry::register('select', \Luttje\FilamentUserAttributes\Filament\Factories\SelectComponentFactory::class);
        UserAttributeComponentFactoryRegistry::register('checkbox', \Luttje\FilamentUserAttributes\Filament\Factories\CheckboxComponentFactory::class);
        UserAttributeComponentFactoryRegistry::register('toggle', \Luttje\FilamentUserAttributes\Filament\Factories\ToggleComponentFactory::class);
        UserAttributeComponentFactoryRegistry::register('radio', \Luttje\FilamentUserAttributes\Filament\Factories\RadioComponentFactory::class);

        UserAttributeComponentFactoryRegistry::register('datetime', \Luttje\FilamentUserAttributes\Filament\Factories\DateTimeComponentFactory::class);
    }

    /**
     * Register a custom filament form component to be added to the user attributes configuration form.
     */
    public function registerUserAttributeConfigComponent(Component|Closure $component): void
    {
        $this->registeredConfigComponents[] = $component;
    }

    /**
     * Returns all registered user attribute config components.
     */
    public function getUserAttributeConfigComponents(UserAttributeConfig $configModel): array
    {
        $components = [];

        foreach ($this->registeredConfigComponents as $component) {
            if ($component instanceof Closure) {
                $component = $component($configModel);
            }

            if (!$component) {
                continue;
            }

            $components[] = $component;
        }

        return $components;
    }

    /**
     * Returns the user attribute columns.
     */
    public function getUserAttributeColumns(string $resource): array
    {
        $config = $this->getUserAttributeConfig($resource);

        if (!in_array(ConfiguresUserAttributes::class, class_uses_recursive($config))) {
            throw new \Exception("The resource '$resource' does not correctly use the ConfiguresUserAttributes trait");
        }

        return $config->getUserAttributeColumns($resource);
    }

    /**
     * Returns the user attribute fields.
     */
    public function getUserAttributeFields(string $resource): array
    {
        $config = $this->getUserAttributeConfig($resource);

        if (!in_array(ConfiguresUserAttributes::class, class_uses_recursive($config))) {
            throw new \Exception("The resource '$resource' does not use the ConfiguresUserAttributes trait");
        }

        return $config->getUserAttributeFields($resource);
    }

    /**
     * Returns the user attribute configuration model.
     */
    public function getUserAttributeConfig(string $resource): ConfiguresUserAttributesContract
    {
        if (!in_array(UserAttributesConfigContract::class, class_implements($resource))) {
            throw new \Exception("The resource '$resource' does not implement the UserAttributesConfigContract interface.");
        }

        /** @var ?UserAttributesConfigContract */
        $resource = $resource;
        $config = $resource::getUserAttributesConfig();

        if ($config === null) {
            throw new \Exception("The resource '" . strval($resource) . "' did not return a configuration model from the getUserAttributesConfig function (or it was null).");
        }

        return $config;
    }

    public static function normalizePath(string $path): string
    {
        return str_replace('/', DIRECTORY_SEPARATOR, $path);
    }

    public static function normalizePaths(array $paths): array
    {
        return array_map(function ($path) {
            return self::normalizePath($path);
        }, $paths);
    }

    public static function normalizeClassName(string $className): string
    {
        return str_replace('/', '\\', $className);
    }

    public static function normalizeClassNames(array $classNames): array
    {
        return array_map(function ($className) {
            return self::normalizeClassName($className);
        }, $classNames);
    }

    /**
     * Returns all Resource discover paths, normalized
     */
    public function getResourceDiscoverPaths(): array|false
    {
        $discoverPaths = config('filament-user-attributes.discover_resources');

        if ($discoverPaths === false) {
            return false;
        }

        return self::normalizePaths($discoverPaths);
    }

    /**
     * Finds all resources that have the HasUserAttributesContract interface
     */
    public function getConfigurableResources($configuredOnly = true)
    {
        $discoverPaths = $this->getResourceDiscoverPaths();

        if ($discoverPaths === false) {
            $resources = $this->registeredResources;

            if ($resources instanceof Closure) {
                return $resources();
            }

            return $resources;
        }

        if ($this->cachedDiscoveredResources === null) {
            $this->cachedDiscoveredResources = $this->discoverConfigurableResources($discoverPaths, $configuredOnly);
        }

        return $this->cachedDiscoveredResources;
    }

    /**
     * Discovers all resources that have the HasUserAttributesContract interface
     */
    public function discoverConfigurableResources(array $paths, bool $configuredOnly): array
    {
        $resources = [];

        foreach ($paths as $targetPath) {
            $path = $this->appPath . $targetPath;

            if (!File::exists($path)) {
                continue;
            }

            $nameTransformer = config('filament-user-attributes.discovery_resource_name_transformer');

            $resourcesForPath = collect(File::files($path))
                ->map(function ($file) use ($targetPath) {
                    $type = $this->appNamespace . static::normalizeClassName($targetPath) . '\\' . $file->getRelativePathName();
                    $type = substr($type, 0, -strlen('.php'));

                    return $type;
                });

            // Note: this will autoload the models if $configured = true
            if ($configuredOnly) {
                $resourcesForPath = $resourcesForPath->filter(function ($type) {
                    if (!class_exists($type)) {
                        return false;
                    }

                    if (!in_array(\Luttje\FilamentUserAttributes\Contracts\UserAttributesConfigContract::class, class_implements($type))) {
                        return false;
                    }

                    return true;
                });
            }

            $resourcesForPath = $resourcesForPath->mapWithKeys(function ($type) use ($nameTransformer) {
                return [$type => $nameTransformer($type)];
            })
                ->toArray();

            $resources = array_merge($resources, $resourcesForPath);
        }

        return $resources;
    }

    /**
     * Discovers all models that could possibly be configured with user attributes.
     */
    public function getConfigurableModels($configuredOnly = true)
    {
        $discoverPaths = config('filament-user-attributes.discover_models');

        if ($discoverPaths === false) {
            return [];
        }

        return $this->discoverConfigurableModels($discoverPaths, $configuredOnly);
    }

    /**
     * Discovers all models that could possibly be configured with user attributes.
     */
    public function discoverConfigurableModels(array $paths, bool $configuredOnly): array
    {
        $models = [];

        foreach ($paths as $targetPath) {
            $path = $this->appPath . $targetPath;

            if (!File::exists($path)) {
                continue;
            }

            $modelsForPath = collect(File::files($path))
                ->map(function ($file) use ($targetPath) {
                    $type = $this->appNamespace . static::normalizeClassName($targetPath) . '\\' . $file->getRelativePathName();
                    $type = substr($type, 0, -strlen('.php'));

                    return $type;
                });

            // Note: this will autoload the models if $configured = true
            if ($configuredOnly) {
                $modelsForPath = $modelsForPath->filter(function ($type) {
                    if (!class_exists($type)) {
                        return false;
                    }

                    if (!in_array(\Luttje\FilamentUserAttributes\Contracts\HasUserAttributesContract::class, class_implements($type))) {
                        return false;
                    }

                    return true;
                });
            }

            $models = array_merge($models, $modelsForPath->toArray());
        }

        return $models;
    }

    /**
     * Uses configured path discovery information to find the path for the given
     * resource class
     */
    public function findResourceFilePath(string $resource): string
    {
        $discoverPaths = $this->getResourceDiscoverPaths();

        foreach ($discoverPaths as $targetPath) {
            $path = $this->appPath . $targetPath;

            if (!File::exists($path)) {
                continue;
            }

            $file = $path . DIRECTORY_SEPARATOR . class_basename($resource) . '.php';

            if (File::exists($file)) {
                return $file;
            }
        }

        throw new \Exception("Could not find the file for resource '$resource'. Did you forget to add it's directory to the 'filament-user-attributes.discover_resources' config option?");
    }

    /**
     * Uses configured path discovery information to find the path for the given
     * model class
     */
    public function findModelFilePath(string $model): string
    {
        $discoverPaths = config('filament-user-attributes.discover_models');

        foreach ($discoverPaths as $targetPath) {
            $path = $this->appPath . $targetPath;

            if (!File::exists($path)) {
                continue;
            }

            $file = $path . DIRECTORY_SEPARATOR . class_basename($model) . '.php';

            if (File::exists($file)) {
                return $file;
            }
        }

        throw new \Exception("Could not find the file for model '$model'. Did you forget to add it's directory to the 'filament-user-attributes.discover_models' config option?");
    }

    /**
     * Helper function to get label for a component.
     */
    private function getComponentLabel($component, ?string $parentLabel = null): string
    {
        $label = $component->getLabel();

        if ($label === null) {
            $label = '';
        }

        return $parentLabel ? ($parentLabel . ' > ' . $label) : $label;
    }

    /**
     * Gets all components and child components as a flat array of names with labels
     */
    public function getAllFieldComponents(array $components, ?string $parentLabel = null): array
    {
        $namesWithLabels = [];

        foreach ($components as $component) {
            $label = $this->getComponentLabel($component, $parentLabel);

            if ($component instanceof \Filament\Forms\Components\Field) {
                $namesWithLabels[] = [
                    'name' => $component->getName(),
                    'label' => $label,
                    'statePath' => $component->getStatePath(false),
                ];
            }

            if ($this->componentHasChildren($component)) {
                $namesWithLabels = array_merge(
                    $namesWithLabels,
                    $this->getAllFieldComponents(
                        $component->getChildComponents(),
                        $label
                    )
                );
            }
        }

        return $namesWithLabels;
    }

    /**
     * Gets all columns as a flat array of names with labels
     */
    public function getAllTableColumns(array $columns): array
    {
        $namesWithLabels = [];

        /** @var Column $column */
        foreach ($columns as $column) {
            $label = $this->getComponentLabel($column);
            $namesWithLabels[] = [
                'name' => $column->getName(),
                'label' => $label,
            ];
        }

        return $namesWithLabels;
    }

    /**
     * Search the components and child components until the component with the given name is found,
     * then add the given component after it.
     */
    public function addFieldBesidesField(
        array $components,
        string $siblingComponentName,
        string $position,
        Component $componentToAdd,
        ?string $parentLabel = null,
        &$siblingFound = false
    ): array {
        $newComponents = [];

        foreach ($components as $component) {
            $label = $this->getComponentLabel($component, $parentLabel);

            $newComponents[] = $component;

            if ($component instanceof \Filament\Forms\Components\Field
            && $label === $siblingComponentName) {
                $siblingFound = true;
                if ($position === 'before') {
                    array_splice($newComponents, count($newComponents) - 1, 0, [$componentToAdd]);
                } elseif($position === 'after') {
                    $newComponents[] = $componentToAdd;
                }
            }

            if ($this->componentHasChildren($component)) {
                $containerChildComponents = $component->getChildComponents();
                $childComponents = $this->addFieldBesidesField(
                    $containerChildComponents,
                    $siblingComponentName,
                    $position,
                    $componentToAdd,
                    $label,
                    $siblingFound
                );

                $component->childComponents($childComponents);
            }
        }

        if (!$siblingFound && $parentLabel === null) {
            $newComponents[] = $componentToAdd;
        }

        return $newComponents;
    }

    /**
     * Search the columns and child columns until the column with the given name is found,
     * unlike with forms, tables simply have columns in a flat array next to each other.
     */
    public function addColumnBesidesColumn(array $columns, string $siblingColumnName, string $position, Column $columnToAdd): array
    {
        $newColumns = [];

        foreach ($columns as $column) {
            $label = $this->getComponentLabel($column);
            $newColumns[] = $column;

            if ($label === $siblingColumnName) {
                if ($position === 'before') {
                    array_splice($newColumns, count($newColumns) - 1, 0, [$columnToAdd]);
                } elseif ($position === 'after') {
                    $newColumns[] = $columnToAdd;
                } else {
                    throw new \Exception("Invalid position '$position' given.");
                }
            }
        }

        return $newColumns;
    }

    /**
     * Merges the custom fields into the given form schema.
     */
    public function mergeCustomFormFields(array $fields, string $resource): array
    {
        $customFields = collect(FilamentUserAttributes::getUserAttributeFields($resource));
        $customFieldCount = $customFields->count();

        $inheritingFieldsMap = $customFields->filter(function ($customField) {
            return $customField['inheritance']['enabled'] === true;
        })->mapWithKeys(function ($customField) {
            $key = $customField['inheritance']['relation'];

            if ($key === '__self') {
                $key = $customField['inheritance']['attribute'];
            }

            return [$key => $customField];
        });

        for ($i = 0; $i < $customFieldCount; $i++) {
            $customField = $customFields->pop();

            if (!isset($customField['ordering'])
                || $customField['ordering']['sibling'] === null) {
                $customFields->prepend($customField);
                continue;
            }

            $fields = $this->addFieldBesidesField(
                $fields,
                $customField['ordering']['sibling'],
                $customField['ordering']['position'],
                $customField['field']
            );
        }

        $fields = array_merge($fields, $customFields->pluck('field')->toArray());

        $this->addStateChangeSignalToInheritedFields($fields, $inheritingFieldsMap);

        return $fields;
    }

    /**
     * Adds a state change signal to all fields that inherit from another model.
     * This ensures the inherited field updates, when the related field value
     * changes.
     */
    public function addStateChangeSignalToInheritedFields(array $fields, $inheritingFieldsMap): void
    {
        /** @var Component $field */
        foreach ($fields as $field) {
            if ($this->componentHasChildren($field)) {
                $this->addStateChangeSignalToInheritedFields(
                    $field->getChildComponents(),
                    $inheritingFieldsMap
                );
            }

            $statePath = $field->getStatePath(false);
            $statePath = preg_replace('/_id$/', '', $statePath);
            $inheritingField = $inheritingFieldsMap->get($statePath);

            if (!$inheritingField) {
                continue;
            }

            // Ensure that the related field is live, so that state changes are reactive.
            if (!$field->isLive()) {
                $field->live();
            }

            $field->afterStateUpdated(static function (Component $component) use ($inheritingField): void {
                $components = $component->getContainer()
                    ->getFlatComponents(true);

                foreach ($components as $component) {
                    if ($component->getId() !== $inheritingField['field']->getId()) {
                        continue;
                    }

                    $component->fill();
                }
            });
        }
    }

    /**
     * Merges the custom columns into the given table schema.
     */
    public function mergeCustomTableColumns(array $columns, $resource): array
    {
        $customColumns = collect(FilamentUserAttributes::getUserAttributeColumns($resource));
        $customColumnCount = $customColumns->count();

        for ($i = 0; $i < $customColumnCount; $i++) {
            $customColumn = $customColumns->pop();

            if (!isset($customColumn['ordering'])
                || $customColumn['ordering']['sibling'] === null) {
                $customColumns->prepend($customColumn);
                continue;
            }

            $columns = $this->addColumnBesidesColumn(
                $columns,
                $customColumn['ordering']['sibling'],
                $customColumn['ordering']['position'],
                $customColumn['column']
            );
        }

        return array_merge($columns, $customColumns->pluck('column')->toArray());
    }

    /**
     * Converts a class name to a human readable label by getting
     * the last part of the name and adding spaces between words.
     */
    public function classNameToLabel(string $className): string
    {
        if (method_exists($className, 'getModelLabel')) {
            $label = $className::getModelLabel();

            if (!empty($label)) {
                return $label . ucfirst(__('filament-user-attributes::user-attributes.suffix_page'));
            }
        }

        $className = class_basename($className);
        $className = preg_replace('/(?<!^)[A-Z]/', ' $0', $className);
        $className = preg_replace('/Resource$/', ucfirst(__('filament-user-attributes::user-attributes.suffix_page')), $className);

        return $className;
    }

    /**
     * Converts a model class name to a human readable label by getting
     * the last part of the name and translating it using the validation
     * localization file.
     */
    public function classNameToModelLabel(string $className, int $amount = 1): string
    {
        $className = class_basename($className);
        $className = trans_choice('validation.attributes.' . Str::snake($className), $amount);

        return $className;
    }

    /**
     * Tries to get a model from the given resource class through the getModel method.
     * If the getModel method is not found, the user is informed on how to properly
     * implement Livewire components.
     */
    public function getModelFromResource(string $resource): string
    {
        if (!method_exists($resource, 'getModel')) {
            throw new \Exception("The resource '$resource' does not implement the getModel method. If you are using a Livewire component, you need to implement the static getModel method yourself.");
        }

        $model = $resource::getModel();

        if ($model === null) {
            throw new \Exception("The resource '$resource' did not return a model from the static getModel function (or it was null).");
        }

        return $model;
    }

    /**
     * Gets all resources mapped by their models
     */
    public function getResourcesByModel(): Collection
    {
        $resources = $this->getConfigurableResources();
        $modelsMappedToResources = collect($resources)
            ->filter(function ($name, string $class) {
                return method_exists($class, 'getModel');
            })
            ->mapWithKeys(function ($name, string $class) {
                return [$this->getModelFromResource($class) => $class];
            });

        return $modelsMappedToResources;
    }
}

luttje / filament-user-attributes / 7254443569

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous