Arcanedev\LaravelPolicies\Ability

Complexity

Total Complexity

24

Size/Duplication

Total Lines	262
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	2
A	make()	0	4	1
A	key()	0	4	1
A	setKey()	0	6	1
A	method()	0	4	1
A	methodName()	0	7	2
A	className()	0	11	3
A	callback()	0	4	1
A	setMethod()	0	6	1
A	metas()	0	4	1
A	setMetas()	0	6	2
A	meta()	0	4	1
A	setMeta()	0	6	1
A	isClosure()	0	4	1
A	toArray()	0	8	2
A	toJson()	0	4	1
A	jsonSerialize()	0	4	1
A	__toString()	0	4	1

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelPolicies;

use Arcanedev\LaravelPolicies\Contracts\Ability as AbilityContract;
use Closure;
use Illuminate\Support\Arr;

/**
 * Class     Ability
 *
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class Ability implements AbilityContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var  string */
    protected $key;

    /** @var  string|\Closure */
    private $method;

    /** @var  array */
    private $metas = [];

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Ability constructor.
     *
     * @param  string                $key
     * @param  string|\Closure|null  $method
     */
    public function __construct(string $key, $method = null)
    {
        $this->setKey($key);
        $this->setMethod($method ?: function () {});
    }

    /**
     * Make an ability.
     *
     * @param  string                $key
     * @param  string|\Closure|null  $method
     *
     * @return self
     */
    public static function make(string $key, $method = null): self
    {
        return new static($key, $method);
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the ability's key.
     *
     * @return string
     */
    public function key(): string
    {
        return $this->key;
    }

    /**
     * Set the ability's key.
     *
     * @param  string  $key
     *
     * @return $this
     */
    public function setKey(string $key): self
    {
        $this->key = $key;

        return $this;
    }

    /**
     * Get the ability's method.
     *
     * @return \Closure|string
     */
    public function method()
    {
        return $this->method;
    }

    /**
     * Get the ability's method name.
     *
     * @return string|null
     */
    public function methodName()
    {
        if ($this->isClosure())
            return null;

        return last(explode('@', $this->method()));
    }

    /**
     * Get the ability's class name.
     *
     * @param  bool  $fqn
     *
     * @return  string|null
     */
    public function className(bool $fqn = true)
    {
        if ($this->isClosure())
            return null;

        $class = head(explode('@', $this->method()));

        return $fqn
            ? $class
            : class_basename($class);
    }

    /**
     * Set the callback as method.
     *
     * @param  \Closure  $callback
     *
     * @return $this
     */
    public function callback(Closure $callback): self
    {
        return $this->setMethod($callback);
    }

    /**
     * Set the ability's method.
     *
     * @param  \Closure|string  $method
     *
     * @return self
     */
    public function setMethod($method): self
    {
        $this->method = $method;

        return $this;
    }

    /**
     * Get the ability's meta.
     *
     * @return array
     */
    public function metas(): array
    {
        return $this->metas;
    }

    /**
     * Set the ability's meta.
     *
     * @param  array  $metas
     * @param  bool   $keepMetas
     *
     * @return self
     */
    public function setMetas(array $metas, bool $keepMetas = true): self
    {
        $this->metas = array_merge($keepMetas ? $this->metas : [], $metas);

        return $this;
    }

    /**
     * Get a meta.
     *
     * @param  string      $key
     * @param  mixed|null  $default
     *
     * @return mixed
     */
    public function meta(string $key, $default = null)
    {
        return Arr::get($this->metas, $key, $default);
    }

    /**
     * Set a meta.
     *
     * @param  string  $key
     * @param  mixed   $value
     *
     * @return self
     */
    public function setMeta(string $key, $value): self
    {
        Arr::set($this->metas, $key, $value);

        return $this;
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check if the ability is a callback method.
     *
     * @return bool
     */
    public function isClosure(): bool
    {
        return $this->method instanceof Closure;
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get the instance as an array.
     *
     * @return array
     */
    public function toArray(): array
    {
        return [
            'key'    => $this->key(),
            'method' => $this->isClosure() ? 'Closure' : $this->method(),
            'metas'  => $this->metas(),
        ];
    }

    /**
     * Convert the object to its JSON representation.
     *
     * @param  int  $options
     *
     * @return string
     */
    public function toJson($options = 0): string
    {
        return json_encode($this->jsonSerialize(), $options);
    }

    /**
     * Convert the object into something JSON serializable.
     *
     * @return array
     */
    public function jsonSerialize(): array
    {
        return $this->toArray();
    }

    /**
     * Convert the object to string as JSON representation.
     *
     * @return string
     */
    public function __toString(): string
    {
        return $this->toJson();
    }
}