[WIP] Add deprecate notes

composer.json

@@ -26,7 +26,8 @@
         "laravel/laravel": "5.*",
         "codeclimate/php-test-reporter": "^0.3.2",
         "mockery/mockery": "^0.9.5",
-        "doctrine/dbal": "^2.5"
+        "doctrine/dbal": "^2.5",
+        "symfony/phpunit-bridge": "^3.1"
     },
     "autoload": {
         "psr-4": {

src/Traits/Friendable.php

@@ -30,7 +30,7 @@ public function befriend(Model $recipient)
             'status' => Status::PENDING,
         ]);
 
-        $this->friends()->save($friendship);
+        $this->friendshipRequests()->save($friendship);
 
         Event::fire('friendships.sent', [$this, $recipient]);
 
@@ -185,7 +185,7 @@ public function blockFriend(Model $recipient)
 
         Event::fire('friendships.blocked', [$this, $recipient]);
 
-        return $this->friends()->save($friendship);
+        return $this->friendshipRequests()->save($friendship);
     }
 
     /**
@@ -201,63 +201,81 @@ public function unblockFriend(Model $recipient)
     }
 
     /**
+     * @deprecated Will be removed in version 2
+     *
      * @param Model $recipient
      *
      * @return \Hootlex\Friendships\Models\Friendship
      */
     public function getFriendship(Model $recipient)
     {
+        @trigger_error(sprintf('The ' . __METHOD__ . ' method was deprecated in version 1.1 and will be removed in version 2.0. You should implement this method yourself in %s.', get_class($this)), E_USER_DEPRECATED);
         return $this->findFriendship($recipient)->first();
     }
 
     /**
+     * @deprecated Will be removed in version 2
+     *
      * @return \Illuminate\Database\Eloquent\Collection
      *
      * @param string $groupSlug
      *
      */
     public function getAllFriendships($groupSlug = '')
     {
+        @trigger_error(sprintf('The ' . __METHOD__ . ' method was deprecated in version 1.1 and will be removed in version 2.0. You should implement this method yourself in %s.', get_class($this)), E_USER_DEPRECATED);
         return $this->findFriendships(null, $groupSlug)->get();
     }
 
     /**
+     * @deprecated Will be removed in version 2
+     *
      * @return \Illuminate\Database\Eloquent\Collection
      *
      * @param string $groupSlug
      *
      */
     public function getPendingFriendships($groupSlug = '')
     {
+        @trigger_error(sprintf('The ' . __METHOD__ . ' method was deprecated in version 1.1 and will be removed in version 2.0. You should implement this method yourself in %s.', get_class($this)), E_USER_DEPRECATED);
         return $this->findFriendships(Status::PENDING, $groupSlug)->get();
     }
 
     /**
+     * @deprecated Will be removed in version 2
+     *
      * @return \Illuminate\Database\Eloquent\Collection
      *
      * @param string $groupSlug
      *
      */
     public function getAcceptedFriendships($groupSlug = '')
     {
+        @trigger_error(sprintf('The ' . __METHOD__ . ' method was deprecated in version 1.1 and will be removed in version 2.0. You should implement this method yourself in %s.', get_class($this)), E_USER_DEPRECATED);
         return $this->findFriendships(Status::ACCEPTED, $groupSlug)->get();
     }
 
     /**
+     * @deprecated Will be removed in version 2
+     *
      * @return \Illuminate\Database\Eloquent\Collection
      *
      */
     public function getDeniedFriendships()
     {
+        @trigger_error(sprintf('The ' . __METHOD__ . ' method was deprecated in version 1.1 and will be removed in version 2.0. You should implement this method yourself in %s.', get_class($this)), E_USER_DEPRECATED);
         return $this->findFriendships(Status::DENIED)->get();
     }
 
     /**
+     * @deprecated Will be removed in version 2
+     *
      * @return \Illuminate\Database\Eloquent\Collection
      *
      */
     public function getBlockedFriendships()
     {
+        @trigger_error(sprintf('The ' . __METHOD__ . ' method was deprecated in version 1.1 and will be removed in version 2.0. You should implement this method yourself in %s.', get_class($this)), E_USER_DEPRECATED);
         return $this->findFriendships(Status::BLOCKED)->get();
     }
 
@@ -268,7 +286,7 @@ public function getBlockedFriendships()
      */
     public function hasBlocked(Model $recipient)
     {
-        return $this->friends()->whereRecipient($recipient)->whereStatus(Status::BLOCKED)->exists();
+        return $this->friendshipRequests()->whereRecipient($recipient)->whereStatus(Status::BLOCKED)->exists();
     }
 
     /**
@@ -282,27 +300,33 @@ public function isBlockedBy(Model $recipient)
     }
 
     /**
+     * @deprecated Will be removed in version 2.
+     *
      * @return \Illuminate\Database\Eloquent\Collection
      */
     public function getFriendRequests()
     {
+        @trigger_error(sprintf('The ' . __METHOD__ . ' method was deprecated in version 1.1 and will be removed in version 2.0.'), E_USER_DEPRECATED);
         return Friendship::whereRecipient($this)->whereStatus(Status::PENDING)->get();
     }
 
     /**
      * This method will not return Friendship models
      * It will return the 'friends' models. ex: App\User
      *
+     * @deprecated Will be removed in version 2
+     *
      * @param int $perPage Number
      * @param string $groupSlug
      *
      * @return \Illuminate\Database\Eloquent\Collection
      */
     public function getFriends($perPage = 0, $groupSlug = '')
     {
+        @trigger_error(sprintf('The ' . __METHOD__ . ' method was deprecated in version 1.1 and will be removed in version 2.0. You should implement this method yourself in %s.', get_class($this)), E_USER_DEPRECATED);
         return $this->getOrPaginate($this->getFriendsQueryBuilder($groupSlug), $perPage);
     }
-    
+
     /**
      * This method will not return Friendship models
      * It will return the 'friends' models. ex: App\User
@@ -315,7 +339,7 @@ public function getMutualFriends(Model $other, $perPage = 0)
     {
         return $this->getOrPaginate($this->getMutualFriendsQueryBuilder($other), $perPage);
     }
-    
+
     /**
      * Get the number of friends
      *
@@ -337,6 +361,7 @@ public function getMutualFriendsCount($other)
     public function getFriendsOfFriends($perPage = 0)
     {
         return $this->getOrPaginate($this->friendsOfFriendsQueryBuilder(), $perPage);
+
     }
 
 
@@ -368,7 +393,7 @@ public function canBefriend($recipient)
         }
 
         // if sender has a friendship with the recipient return false
-        if ($friendship = $this->getFriendship($recipient)) {
+        if ($friendship = $this->findFriendship($recipient)->first()) {
             // if previous friendship was Denied then let the user send fr
             if ($friendship->status != Status::DENIED) {
                 return false;
@@ -497,9 +522,20 @@ private function friendsOfFriendsQueryBuilder($groupSlug = '')
     }
 
     /**
+     * @deprecated Will be removed in version 2
+     *
      * @return \Illuminate\Database\Eloquent\Relations\MorphMany
      */
     public function friends()
+    {
+        @trigger_error(sprintf('The ' . __METHOD__ . ' method was deprecated in version 1.1 and will be removed in version 2.0. You should implement this method yourself in %s.', get_class($this)), E_USER_DEPRECATED);
+        return $this->morphMany(Friendship::class, 'sender');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     */
+    protected function friendshipRequests()
     {
         return $this->morphMany(Friendship::class, 'sender');
     }

tests/FriendshipsEventsTest.php

@@ -1,10 +1,13 @@
 <?php
 
+require_once 'Test.php';
+
 use Illuminate\Foundation\Testing\WithoutMiddleware;
 use Illuminate\Foundation\Testing\DatabaseMigrations;
 use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Test as BaseTest;
 
-class FriendshipsEventsTest extends TestCase
+class FriendshipsEventsTest extends BaseTest
 {
     // use DatabaseTransactions;
 

tests/FriendshipsGroupsTest.php

@@ -1,17 +1,20 @@
 <?php
 
+require_once 'Test.php';
+
 use Illuminate\Foundation\Testing\WithoutMiddleware;
 use Illuminate\Foundation\Testing\DatabaseMigrations;
 use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Test as BaseTest;
 
-/*
+/**
  * Test User Personal Friend Groups
-*/
-class FriendshipsGroupsTest extends TestCase
+ * @group legacy
+ */
+class FriendshipsGroupsTest extends BaseTest
 {
     use DatabaseTransactions;
-
-
+
     /** @test */
     public function user_can_add_a_friend_to_a_group()
     {

tests/FriendshipsTest.php

@@ -1,13 +1,20 @@
 <?php
 
+require_once 'Test.php';
+
 use Illuminate\Foundation\Testing\WithoutMiddleware;
 use Illuminate\Foundation\Testing\DatabaseMigrations;
 use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Test as BaseTest;
 
-class FriendshipsTest extends TestCase
+/**
+ * Test User Friend
+ * @group legacy
+ */
+class FriendshipsTest extends BaseTest
 {
-    // use DatabaseTransactions;
-    
+    use DatabaseTransactions;
+
     /** @test */
     public function user_can_send_a_friend_request()
     {

tests/Test.php

@@ -0,0 +1,26 @@
+<?php
+
+abstract class Test extends TestCase
+{
+    public function createApplication()
+    {
+        $app = require __DIR__ . '/../vendor/laravel/laravel/bootstrap/app.php';
+
+        if ( ! $app->hasBeenBootstrapped())
+        {
+            $app->bootstrapWith(
+                [
+                    'Illuminate\Foundation\Bootstrap\DetectEnvironment',
+                    'Illuminate\Foundation\Bootstrap\LoadConfiguration',
+                    'Illuminate\Foundation\Bootstrap\ConfigureLogging',
+                    'Illuminate\Foundation\Bootstrap\RegisterFacades',
+                    'Illuminate\Foundation\Bootstrap\SetRequestForConsole',
+                    'Illuminate\Foundation\Bootstrap\RegisterProviders',
+                    'Illuminate\Foundation\Bootstrap\BootProviders',
+                ]
+            );
+        }
+
+        return $app;
+    }
+}