Refactor API from v5 to v6 about laravel-love

[antonkomarev]

(?) Magical attributes

Magical calls of the attributes $article->liked & $article->disliked could be dropped. Since it only Laravel related and doesn't give any benefits.

[antonkomarev]

(?) LikeableService contract

Old

public function addLikeTo(Likeable $likeable, $type, $userId);
public function removeLikeFrom(Likeable $likeable, $type, $userId);
public function toggleLikeOf(Likeable $likeable, $type, $userId);
public function isLiked(Likeable $likeable, $type, $userId): bool;

New

Change methods argument order in LikeableService contract and accept only strict types.

public function addLikeTo(Likeable $likeable, Liker $user, LikeType $type);
public function removeLikeFrom(Likeable $likeable, Liker $user, LikeType $type);
public function toggleLikeOf(Likeable $likeable, Liker $user, LikeType $type);
public function isLiked(Likeable $likeable, Liker $user, LikeType $type): bool;

[antonkomarev]

(?) Strict types in Likeable model methods

Old

Methods likeBy, dislikeBy, isLikedBy, isDislikedBy, toggleLikedBy, toggleDislikedBy accepts argument $user with values of:

• null what means it's called by current user;
• explicit integer or string user_id attribute of the Liker;
• model which implements Cog\Contracts\Love\Liker\Models\Liker.

$article->likeBy($user);
$article->dislikeBy($user);

$article->isLikedBy($user);
$article->isDislikedBy($user);

$article->toggleLikeBy($user);
$article->toggleDislikeBy($user);

New

It will be good to pass Liker model to Likeable methods likeBy, dislikeBy, isLikedBy, isDislikedBy, toggleLikeBy, toggleDislikeBy instead of user_id.

$article->likeBy(Liker $user);
$article->dislikeBy(Liker $user);

$article->isLikedBy(Liker $user);
$article->isDislikedBy(Liker $user);

$article->toggleLikeBy(Liker $user);
$article->toggleDislikeBy(Liker $user);

[antonkomarev]

(?) Assert likes by current user

Old

$article->isLikedBy();
$article->isDislikedBy();

New

We should throw ability to check likes by current user or we could add new helper methods if needed. Otherwise it's not explicit that check uses current user.

$article->isLikedByMe();
$article->isDislikedByMe();

[antonkomarev]

Relationships

Old implementation

Relationships exists only in Likeable model now:

// Likes and dislikes related to Likeable
$likesAndDislikes = $article->likesAndDislikes();

// Likes related to Likeable
$likes = $article->likes();

// Dislikes related to Likeable
$dislikes = $article->dislikes();

New implementation

Under discussion in #7.

[antonkomarev]

Closing this issue since its outdated. I've completely revised an API of the next package version.
More details about v6: #15