Emanci\Rally\Traits\CanFollow

Complexity

Total Complexity

7

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

70.59%

Importance

Changes	5
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	toggleFollow()	0	6	1
A	following()	0	4	1
A	follow()	0	6	1
A	unfollow()	0	6	1
A	isFollowing()	0	4	1
A	parseFollowable()	0	8	2

<?php

/*
 * This file is part of emanci/laravel-rally package.
 *
 * (c) emanci <zhengchaopu@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Emanci\Rally\Traits;

use Illuminate\Database\Eloquent\Model;

trait CanFollow
{
    /**
     * Follow a followable entity.
     *
     * @param int|array|\Illuminate\Database\Eloquent\Model $followable
     * @param string                                        $className
     *
     * @return array
     */
    public function follow($followable, $className = __CLASS__)
    {
        $followable = $this->parseFollowable($followable);

        return $this->following($className)->sync($followable, false);

It seems like $followable defined by $this->parseFollowable($followable) on line 28 can also be of type integer; however, Illuminate\Database\Eloquent\Relations\Concerns\InteractsWithPivotTable::sync() does only seem to accept object<Illuminate\Support\Collection>|array, maybe add an additional type check?

    }

    /**
     * Unfollow a followable entity.
     *
     * @param int|array|\Illuminate\Database\Eloquent\Model $followable
     * @param string                                        $className
     *
     * @return bool|null
     */
    public function unfollow($followable, $className = __CLASS__)
    {
        $followable = $this->parseFollowable($followable);

        return $this->following($className)->detach($followable);
    }

    /**
     * Check if entity is following given entity.
     *
     * @param int|\Illuminate\Database\Eloquent\Model $followable
     * @param string                                  $className
     *
     * @return bool
     */
    public function isFollowing($followable, $className = __CLASS__)
    {
        return $this->following($className)->get()->contains($followable);
    }

    /**
     * Toggle follow a followable or followables.
     *
     * @param int|array|\Illuminate\Database\Eloquent\Model $followable
     * @param string                                        $className
     *
     * @return array
     */
    public function toggleFollow($followable, $className = __CLASS__)
    {
        $followable = $this->parseFollowable($followable);

        return $this->following($className)->toggle($followable);
    }

    /**
     * Return entity following.
     *
     * @param string $className
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphToMany
     */
    public function following($className = __CLASS__)
    {
        return $this->morphedByMany($className, config('rally.followable_prefix'), config('rally.followers_table'), config('rally.follower_prefix').'_id', config('rally.followable_prefix').'_id')->withTimestamps();

It seems like morphedByMany() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @param int|array|\Illuminate\Database\Eloquent\Model $followable
     *
     * @return int|array
     */
    protected function parseFollowable($followable)
    {
        if ($followable instanceof Model) {
            return $followable->getKey();
        }

        return $followable;
    }
}