ronanchilvers / deploy

src/Twig/ProjectExtension.php

<?php

namespace App\Twig;

use App\Facades\Security;
use App\Model\Project;
use App\Provider\Factory;
use App\Security\Manager;
use Carbon\Carbon;
use Ronanchilvers\Foundation\Traits\Optionable;
use Ronanchilvers\Orm\Orm;
use Ronanchilvers\Utility\Str;
use Twig\Extension\AbstractExtension;
use Twig\Markup;
use Twig\TwigFunction;

/**
 * Twig extension for github helper methods
 *
 * @author Ronan Chilvers <ronan@d3r.com>
 */
class ProjectExtension extends AbstractExtension
{
    /**
     * @var \App\Provider\Factory
     */
    protected $factory;

    /**
     * @var string
     */
    // protected $repoLinkHtml = '<span class="icon"><i class="fab fa-{provider}"></i></span><a class="button is-text" href="{user_url}" target="_blank"><span>{user}</span></a>/<a class="button is-text" href="{repo_url}" target="_blank">{repo}</a>';
    protected $repoLinkHtml = '<a href="{user_url}" target="_blank">{user}</a>/<a href="{repo_url}" target="_blank">{repo}</a>';

    /**
     * @var string
     */
    protected $branchLinkHtml = '<a href="{url}" target="_blank">{branch}</a>';

    /**
     * @var string
     */
    protected $shaLinkHtml = '<a href="{url}" target="_blank">{sha}</a>';

    /**
     * Class constructor
     *
     * @param \App\Provider\Factory $factory
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    public function __construct(Factory $factory)
    {
        $this->factory = $factory;
    }

    /**
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    public function getFunctions()
    {
        return [
            new TwigFunction(
                'repo_link',
                [$this, 'repositoryLink']
            ),
            new TwigFunction(
                'branch_link',
                [$this, 'branchLink']
            ),
            new TwigFunction(
                'sha_link',
                [$this, 'shaLink']
            ),
            new TwigFunction(
                'current_favourites',
                [$this, 'getCurrentFavourites']
            ),
        ];
    }

    /**
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    public function getFilters()
    {
        return [
            new \Twig\TwigFilter(
                'human_date',
                [$this, 'humanDate']
            ),
        ];
    }

    /**
     * Get a repository link for a given project
     *
     * @param Project $project
     * @return string
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    public function repositoryLink(Project $project)
    {
        $provider = $this->factory->forProject(
            $project
        );
        $bits = explode('/', $project->repository);
        $userUrl = $provider->getRepositoryLink(
            $bits[0]
        );
        $url = $provider->getRepositoryLink(
            $project->repository
        );
        $link = Str::moustaches(
            $this->repoLinkHtml,
            [
                'provider'   => $project->provider,
                'user_url'   => $userUrl,
                'user'       => $bits[0],
                'repo_url'   => $url,
                'repo'       => $bits[1],
            ]
        );

        return new Markup($link, 'UTF-8');
    }

    /**
     * Get a branch link for a given project
     *
     * @param Project $project
     * @return string
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    public function branchLink(Project $project, string $branch = null)
    {
        if (is_null($branch)) {
            $branch = $project->branch;
        }
        $provider = $this->factory->forProject(
            $project
        );
        $url = $provider->getBranchLink(
            $project->repository,
            $branch
        );
        $link = Str::moustaches(
            $this->branchLinkHtml,
            [
                'branch' => $branch,
                'url'    => $url
            ]
        );

        return new Markup($link, 'UTF-8');
    }

    /**
     * Create a link for a given SHA and project
     *
     * @param Project $project
     * @param string $sha
     * @return string
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    public function shaLink(Project $project = null, string $sha = null)
    {
        if (is_null($project) || is_null($sha)) {
            return 'N/A';
        }
        $provider = $this->factory->forProject(
            $project
        );
        $url = $provider->getShaLink(
            $project->repository,
            $sha
        );
        $link = Str::moustaches(
            $this->shaLinkHtml,
            [
                'sha' => substr($sha, 0, 8),
                'url' => $url
            ]
        );

        return new Markup($link, 'UTF-8');
    }

    /**
     * Generate a human readable datetime string from a Carbon object
     *
     * @param \Carbon\Carbon $carbon
     * @return string
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    public function humanDate(Carbon $carbon = null)
    {
        if (is_null($carbon)) {
            return 'N/A';
        }
        // More than a day ago
        if (0 < $carbon->diffInDays()) {
            return $carbon->format('Y-m-d H:i:s');
        }
        // More than 30 minutes ago
        if (1440 < $carbon->diffInMinutes()) {
            return $carbon->format('H:i:s');
        }

        return $carbon->diffForHumans(['parts' => 2]);
    }

    /**
     * Get the favourite projects for the current user
     *
     * @return []

The doc comment [] at position 0 could not be parsed: Unknown type name '[' at position 0 in [].

     * @author Ronan Chilvers <ronan@d3r.com>
     */
    public function getCurrentFavourites()
    {
        $user = Security::user();
        $userFavourites = $user->preference(
            'favourites',
            []
        );
        if (empty($userFavourites)) {
            return [];
        }

        return Orm::finder(Project::class)->all(
            $userFavourites

It seems like $userFavourites can also be of type array; however, parameter $page of Ronanchilvers\Orm\Finder::all() does only seem to accept integer, maybe add an additional type check?

        );
    }
}